Create Messaging Config

Creates new Messaging Config with the options specified in the request. If callback URLs are not specified for a particular event, the callbacks for that event would not be sent.

Authorization

AuthorizationBasic <token>

Basic Authorization header using the BASIC scheme. Use a pair companySid:token to access the API.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Create / Update Messaging Config Request.

inboundCallbackUrl?|

Callback URL for the Inbound Message events. You can find callback payload for InboundMessageEvent in the Webhook Samples.

Length1 <= length <= 512

Example"https://example.com/inboundMessage?source=telgorithm"

outboundCallbackUrl?|

Callback URL for the Outbound Message events. You can find callback payload for OutboundMessageEvent in the Webhook Samples.

Length1 <= length <= 512

Example"https://example.com/outboundMessage?source=telgorithm"

optInOutCallbackUrl?|

Callback URL for the Opt In/Out events. You can find callback payload for OptInOutEvent in the Webhook Samples.

Length1 <= length <= 512

Example"https://example.com/optInOut?source=telgorithm"

tcrCampaignId?|

Linked TCR Campaign ID.

Match^C[0-9A-Z]{6,127}$

Length1 <= length <= 128

Example"C123ABC"

name?|

Name.

Length1 <= length <= 1024

Example"I am messaging config"

authorizationBearer?|

If specified, the Authorization header is added to webhook requests using the Bearer scheme and containing the value provided in this field.

Lengthlength <= 256

Example"MySecretToken123"

sendingTimes?|

Specifies the time zone and time periods in a day when the messaging should be active. SMS and MMS won't be sent outside of these intervals.

optInOutSettings?|

Subscriber settings for opt-in/opt-out/help processes.

Response Body

curl -X POST "https://example.com/v1/MessagingConfigs" \  -H "Content-Type: application/json" \  -d '{    "inboundCallbackUrl": "https://example.com/inboundMessage?source=telgorithm",    "outboundCallbackUrl": "https://example.com/outboundMessage?source=telgorithm",    "optInOutCallbackUrl": "https://example.com/optInOut?source=telgorithm",    "tcrCampaignId": "C123ABC",    "name": "I am messaging config",    "authorizationBearer": "MySecretToken123",    "sendingTimes": {      "timeZoneId": "America/Los_Angeles",      "periods": [        {          "from": "09:30:00",          "to": "19:00:00"        }      ]    },    "optInOutSettings": {      "useTcrCampaignSettings": false,      "optInKeywords": [        "SUBSCRIBE",        "CONTINUE"      ],      "optOutKeywords": [        "EXIT",        "STOPNOW"      ],      "helpKeywords": [        "INFO"      ],      "optInMessage": "You are subscribed to messages from this sender. Msg frequency varies. Reply HELP for help or STOP to unsubscribe. Msg & data rates may apply.",      "optOutMessage": "You are unsubscribed. You will no longer receive messages from this sender. Reply START to resubscribe. Msg & data rates may apply.",      "helpMessage": "Reply STOP to unsubscribe. Msg & data rates may apply."    }  }'

{  "tcrCampaign": {    "id": "C123ABC",    "name": "Customer care campaign",    "tcrBrand": {      "id": "B123ABC",      "name": "My Best Company Inc"    }  },  "sid": "MCf4f1e0ccde19431ebde74a9f2996afa0",  "createdOn": "2023-09-09T15:00:00.000Z",  "outboundCallbackUrl": "https://example.com/outboundMessage?source=telgorithm",  "inboundCallbackUrl": "https://example.com/inboundMessage?source=telgorithm",  "optInOutCallbackUrl": "string",  "tcrCampaignId": "C123ABC",  "name": "I am messaging config",  "authorizationBearer": "MySecretToken123",  "sendingTimes": {    "timeZoneId": "America/Los_Angeles",    "periods": [      {        "from": "09:30:00",        "to": "19:00:00"      }    ]  },  "optInOutSettings": {    "optInKeywords": [      "START",      "UNSTOP",      "SUBSCRIBE",      "CONTINUE"    ],    "optOutKeywords": [      "STOP",      "QUIT",      "END",      "UNSUBSCRIBE",      "EXIT",      "STOPNOW"    ],    "helpKeywords": [      "HELP",      "INFO"    ],    "optInMessage": "You are subscribed to messages from this sender. Msg frequency varies. Reply HELP for help or STOP to unsubscribe. Msg & data rates may apply.",    "optOutMessage": "You are unsubscribed. You will no longer receive messages from this sender. Reply START to resubscribe. Msg & data rates may apply.",    "helpMessage": "Reply STOP to unsubscribe. Msg & data rates may apply."  }}

{  "errors": {    "Name": [      "The Name field is required."    ]  },  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",  "title": "One or more validation errors occurred.",  "status": 400,  "detail": "Some detailed message",  "traceId": "|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}

Create Messaging Config

Authorization

Request Body

Response Body

201text/plain

400text/plain