See the Voice SDK Call Message Events page for more information.
A UserDefinedMessage Resource represents a user-defined message that is sent to a Voice SDK end user during an active Call.
A UserDefinedMessage Resource can only be created during an active Call associated with the Voice SDK.
Read more about the Voice SDK messaging feature on the Voice SDK Call Message Events Page.
The SID of the Account that created User Defined Message.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Call the User Defined Message is associated with.
^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID that uniquely identifies this User Defined Message.
^KX[0-9a-fA-F]{32}$Min length: 34Max length: 34The date that this User Defined Message was created, given in RFC 2822 format.
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessages.json
The SID of the Account that created User Defined Message.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34application/x-www-form-urlencodedA unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
Send a message from the server side to the Voice SDK by making a POST request to an active Call's UserDefinedMessages endpoint.
The content of your message is contained in the Content parameter of your request as a stringified JSON object.
Use the appropriate Call SID in the path of your POST request. Use the parent Call SID if you wish to send a message to parent Call leg. Use the child Call SID if you wish to send a message to the child Call leg.
See the Voice SDK Overview page for more information on Voice SDK Call legs.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function createUserDefinedMessage() {11const userDefinedMessage = await client12.calls("CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")13.userDefinedMessages.create({14content: JSON.stringify({ example_key: "Hello from the server side!" }),15});1617console.log(userDefinedMessage.accountSid);18}1920createUserDefinedMessage();
1{2"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",4"sid": "KXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",5"date_created": "Wed, 18 Dec 2019 20:02:01 +0000"6}