API Reference

Company -- Get SMS Opt-out List

get
https://dialpad.com/api/v2/company//smsoptout

Lists the external phone numbers that have opted out of (or back in to) SMS from this company, filtered by opt-out state and optionally by A2P campaign. Use this before sending SMS to confirm a recipient has not opted out.

Requires a company admin API key.

Rate limit: 250 per minute.

Path Params
string
required

ID of the requested company. This is required and must be specified in the URL path. The value must match the id from the company linked to the API key.

Query Params
int64

Optional company A2P campaign entity id to filter results by. Note, if set,
then the parameter 'opt_out_state' must be also set to the value 'opted_out'.

string

Optional token used to return the next page of a previous request. Use the cursor provided in the previous response.

string
enum
required

Required opt-out state to filter results by. Only results matching this state will be returned.

Allowed:
Response

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?