Send an action

General requirements

Authentication: Basic (easiest to implement) or Digest

Protocols: HTTPS

Encoding: Accepts only UTF-8 unicode characters as inputs.

Accepts: application/json (use JSON-RPC format)

Responds with: application/json

Required headers: Content-Type - application/json

Rate limit: Default rate limits by product

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

The request was successfully processed, but the service could not complete the action.

Error string	Description
`premium_to_number_rejected`	Phone number (`to`) in the request has the unsupported number type "premium". Action rejected.
`to_number_blocked_by_country`	Phone number (`to`) in the request is blocked based on its country of origin. Blocked countries can be specified either by you in the customer portal, or by Telesign. Action rejected.
`to_number_blocked_by_customer`	Phone number (`to`) in the request is on the blocked list in the customer portal. Action rejected.
`to_number_blocked_by_telesign`	Phone number (`to`) in the request is blocked by Telesign for all requests. Action rejected.

Status string	Description
`dial_accepted`	The dial action was completed successfully and the end user answered the call.

Status string

Description

dial_accepted

The dial action was completed successfully and the end user answered the call.

Error string	Description
`caller_id_number_not_owned`	Virtual number (`caller_id_number`) in the request is not owned by you. Action rejected.
`caller_id_number_not_provided`	Request does not include a virtual number (`caller_id_number`). Action rejected.
`invalid_phone_number`	Phone number (`to`) in the request is invalid. Action rejected.
`to_number_not_provided`	Request does not include a phone number (`to`). Action rejected.
`unsupported_call_state`	Action in the request is not supported for current call state, or not supported at all for this event. Action rejected.

Error string

Description

caller_id_number_not_owned

Virtual number (caller_id_number) in the request is not owned by you. Action rejected.

caller_id_number_not_provided

Request does not include a virtual number (caller_id_number). Action rejected.

invalid_phone_number

Phone number (to) in the request is invalid. Action rejected.

to_number_not_provided

Request does not include a phone number (to). Action rejected.

unsupported_call_state

Action in the request is not supported for current call state, or not supported at all for this event. Action rejected.

Error string	Description
`credentials_not_provided`	Customer ID and/or API key missing from the authorization header of the request. Action rejected.
`not_authorized`	Could not authenticate with the Customer ID and API key in the authorization header of the request. Action rejected.

Error string

Description

credentials_not_provided

Customer ID and/or API key missing from the authorization header of the request. Action rejected.

not_authorized

Could not authenticate with the Customer ID and API key in the authorization header of the request. Action rejected.

Error string	Description
`rate_limit_exceeded`	Account has exceeded rate limit for either outbound or inbound requests. Action rejected.

Error string

Description

rate_limit_exceeded

Account has exceeded rate limit for either outbound or inbound requests. Action rejected.

202Success. The request was successfully processed and the action was successfully taken. Status stringDescriptiondial_acceptedThe dial action was completed successfully and the end user answered the call.