Subscribe to User Defined Messages for a given Call SID.

2 parameters · 3 body fields

AccountSidstringrequired

The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that subscribed to the User Defined Messages.

CallSidstringrequired

The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Messages subscription is associated with. This refers to the Call SID that is producing the user defined messages.

Callbackstringrequired

The URL we should call using the `method` to send user defined events to your application. URLs must contain a valid hostname (underscores are not permitted).

IdempotencyKeystringoptional

A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.

Methodstringoptional

The HTTP method Twilio will use when requesting the above `Url`. Either `GET` or `POST`. Default is `POST`.

Allowed:GETPOST

1 status code

201Created

account_sidstringoptional

The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that subscribed to the User Defined Messages.

call_sidstringoptional

The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the User Defined Message Subscription is associated with. This refers to the Call SID that is producing the User Defined Messages.

sidstringoptional

The SID that uniquely identifies this User Defined Message Subscription.

date_createdstringoptional

The date that this User Defined Message Subscription was created, given in RFC 2822 format.

uristringoptional

The URI of the User Defined Message Subscription Resource, relative to `https://api.twilio.com`.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.userDefinedMessageSubscriptionsJson.create({
  accountSid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  callSid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  callback: "example",
  idempotencyKey: "example",
  method: "example",
});

{
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sid": "ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "Wed, 18 Dec 2019 20:02:01 +0000",
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions/ZYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
}

Request

Response