Send Verification Message

Use this method to send a verification message. Charges will apply according to the pricing plan for each successful message delivery. Note that this method is free of charge when used to send codes to your own phone number.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

❗️

Your account will be charged

By calling this resource your account will be charged

RESPONSE PARAMETERS

KEYDESCRIPTION
request_idString Unique identifier of the verification request
phone_numberString The phone number to which the verification code was sent, in the E.164 format
request_costFloat Total request cost incurred by either checkSendAbility or sendVerificationMessage
remaining_balanceFloat Remaining balance in credits. Returned only in response to a request that incurs a charge.
delivery_statusObject The current message delivery status. Returned only if a verification message was sent to the user
verification_statusObject The current status of the verification process
payloadString .Custom payload if it was provided in the request, 0-256 bytes.

ERROR CODES

STATUSCODEDESCRIPTION
403400001009User is not authenticated.
404400005000User is not found.
Body Params
string
required

The phone number in E.164 format (e.g., +306974444444).

string

Unique identifier from the checkSendAbility method

string

Username of the Telegram channel

string

Custom verification code (4-8 numeric characters

string

Length of the generated verification code (4-8)

string

HTTPS URL to receive delivery reports

string

Custom payload (0-128 bytes

int32

Time-to-live in seconds (60-86400)

Headers
string
required
Defaults to Bearer {access_token}

Bearer {access_token}

string
Defaults to application/json

application/json

Language
LoadingLoading…