POST /api/v2/subscriptions/sms

Creates a SMS event subscription. A webhook_id is required so that we know to which url the events shall be sent. A SMS direction is also required in order to limit the direction for which SMS events are sent. Use 'all' to get SMS events for all directions. A target_type and target_id may optionally be provided to scope the events only to SMS to/from that target.

See https://developers.dialpad.com/docs/sms-events for details on how SMS events work, including the payload structure and payload examples.

NOTE: To include the MESSAGE CONTENT in SMS events, your API key needs to have the "message_content_export" OAuth scope for when a target is specified in this API and/or "message_content_export:all" OAuth scope for when no target is specified.

NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs.

Added on April 9th, 2021 for API v2.

Rate limit: 1200 per minute.

Servers

https://dialpad.com/
https://sandbox.dialpad.com/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`direction`	String	Yes	The SMS direction this event subscription subscribes to. Possible values: `"inbound"` `"outbound"` `"all"`
`include_internal`	Boolean	No	Whether or not to trigger SMS events for SMS sent between two users from the same company. Default value: false
`endpoint_id`	Integer	No	The logging endpoint's ID, which is generated after creating a webhook or websocket successfully.
`enabled`	Boolean	No	Whether or not the SMS event subscription is enabled. Default value: true
`status`	Boolean	No	Whether or not to update on each SMS delivery status. Default value: false
`target_id`	Integer	No	The ID of the specific target for which events should be sent.
`target_type`	String	No	The target's type. Possible values: `"room"` `"callrouter"` `"channel"` `"coachingteam"` `"staffgroup"` `"callcenter"` `"department"` `"office"` `"unknown"` `"user"` `"coachinggroup"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.