FlashingCall (VoiceCode)#

FlashingCall (VoiceCode) Request#

To send the message with FlashingCall type, you need to make a request.

To send VoiceCode, you need to specify the FlashingCall type and send a request, containing the code. The specified code (without accompanying text) will be passed to the operator, who will insert it into the text of the message template.

{
"login": "YOUR_LOGIN",
"password": "YOUR_PASSWORD",
"destAddr": "Subscriber's_Number",
"notifyUrl":"URL_for_sending_statuses",
"message": {
   "type": "FLASHINGCALL",
   "data": {
      "text": "1234",
      "ttl": 1
   }
}
}

Parameter	Required	Type	Description
login	yes	string	Partner’s name in the system.
password	yes	string	Partner’s password in the system.
destAddr	yes	string	Subscriber’s phone number. More details It contains the country code, operator code and phone number. For the Russian Federation, the code can be `8`, `7` or `+7`. Examples: `72101234567`, `+72101234567`, `8-210-123-45-67`, `82101234567`.
notifyUrl	no	string	Hostname of the incoming API to obtain the delivery report (see Delivery Status Service). More details This parameter is optional in the request, but when sending you need to consider the following: if the parameter is specified, it cannot be empty; the `notifyUrl` string must be no more than 2048 characters long. If any of the specified conditions are not met, an error will be generated and the request will not be executed.
message	yes	object	Parameters of a message being sent.
message/type	yes	enum	Message type. The value of `FLASHINGCALL` is transmitted.
message/data	yes	object	Parameters of the data being sent.
message/data/text	yes	string	Message text. The message shall contain either a 4-digit or 6-digit numeric code used to call the subscriber. More details By default, a four-digit code is set for sending. To configure the sending of a six-digit code, you should contact the support of the Service Provider. If a message is sent without a code, the request will be rejected with the error `400, Invalid request. Flashing Call text should contain a 4(6)-digit code`. Number of characters of the message text: no more than 2000.
message/data/ttl	yes	integer	FLASHINGCALL (Voice Code) message lifetime. More details The waiting interval for a response is from 1 to 5 minutes. Note If `ttl = 0` or if there are no parameter in the request the value is taken from the default settings set when configuring the integration for each client individually.

FlashingCall Request Result#

The result of the request execution for FlashingCall type message will be a call to the subscriber’s phone from a special numbering capacity.
The last digits of the calling number are the code that is sent in the message text.
The sending code in the text shall consist of four or six digits. By default, a four-digit code is set for sending. To configure the sending of a six-digit code, you should contact the support of the Service Provider.
Response waiting period (ttl) on the call-making is from 1 to 5 minutes.
After sending the message the Service Provider returns a response synchronously.

VoiceCode Request Result#

The result of the VoiceCode type message request will be a call to the subscriber’s phone. When the subscriber picks up the phone, he will hear a voice message that will contain a 4 or 6 digit code.

To activate this service, you should contact the Technical Support Service and agree on the text of the voice message template.