Send call with verification code

post

https://rest-ww.telesign.com/v1/verify/auto/voice/initiate

Use this endpont to initiate verification of the specified phone number using the Telesign App Verify API.

To add this product to your account, contact a Telesign expert. This product is available for Full-service accounts only.

General requirements

Authentication: Basic (easiest to implement) and Digest
Encoding: Accepts only UTF-8 encoded unicode characters as inputs
Accepts: application/x-www-form-urlencoded
Required headers: Content-Type - application/x-www-form-urlencoded
Rate limit: Default rate limits by product

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

phone_number

string

required

Your end user's phone number, including the country code.

carrier

string

The name of the company providing communication services for the device. This parameter takes the form of a string that can be up to 32 characters long.

connection_type

string

The type of connection the device uses, such as WiFi or cellular. This parameter is an integer up to 3 characters long.

device_icc

string

The international country code for the carrier for the device. This is an integer that is 3 characters long.

device_phone_number

string

The phone number associated with the device. This parameter is a string that can be up to 32 characters long.

is_roaming

string

Whether the device is considered to be roaming in the current network, for Global System for Mobile Communications (GSM) purposes. It is an integer that is 1 character long.

is_voice_capable

string

Whether the device is capable of sending and receiving voice calls and messages. It is an integer that is 1 character long.

network_type

string

The type of network the device is in. It is an integer that is 3 characters long.

os_version

string

length between 8 and 8

The version of the operating system the device uses.

platform_version

string

length between 8 and 8

The version of Android the device uses.

verify_code

string

If you choose to specify a code (it should be five digits long), then you would add it to your initiate request as a string as shown in the example. You must have this feature enabled, speak with our Customer Support Team for assistance.

verification_timeout

integer

The time in seconds that the handset is going to wait for the verification call to arrive, from the time it receives a successful initiate response. The call time is limited to 45 seconds.

Responses

Error code	Description
-10001	Not Allowed Host (indicates that the IP address you are connecting from is not authorized to access the service) -or- Unsupported product name
-30002	Account not activated
-30003	Account limit reached
-30014	Invalid App Verify API finalize
-40006	Bad Request
-40007	Rate limit exceeded
-40022	App Verify API not supported

Error codes	Description
-10009	Invalid source IP address
-20002	This product is not enabled for this customer ID
-20003	This feature is not enabled for this CustomerID
-30002	CustomerID Account Not Activated
-30003	CustomerID New Account Limit Reached
-40002	Not Authorized

200Your request was fulfilled and resulted in a new resource being created. If you want to code against a response, you should retrieve the status or error code and use that rather than the HTTP status response.

405Indicates that the request method is known by the server but has been disabled and cannot be used. Error codesDescription-40005Method not allowed

503Service Unavailable, system unavailable, try again. Error codes are listed in the error parameter in the response. Error CodeDescription-90001System unavailable; please try again later