Отправка VOICECODE

Содержание

Отправка VOICECODE#

Совет

Мы рекомендуем использовать канал SMS вместе с VoiceCode для гарантированной доставки кода вашим пользователям.

Операторы связи могут блокировать часть отправленных звонков российским абонентам, в связи с этим уровень доставки VoiceCode может снизиться.

Отправка VOICECODE-сообщений#

POST https://direct.i-dgtl.ru/api/v1/message

Метод позволяет отправлять массив одиночных сообщений (от 1 до 1000)

Headers#

Name	Type	Description
Authorization*	string	`Basic {TOKEN_1}`
Content-Type*	string	`application/json`

Request Body#

Name	Type	Description
channelType*	string	Канал отправки (`VOICECODE`)
senderName*	string	Имя отправителя. Необходимо отправлять значение `voicecode`
destination*	string	Номер абонента
content*	object	Объект с содержимым сообщения
tags	array	Теги сообщения (массив строк). Каждый тег должен соответствовать выражению `^\w+$` (допускаются буквы в любом регистре, цифры и нижнее подчеркивание «_»)
callbackUrl	string	Адрес для отправки callback
callbackEvents	array	События, по которым будут отправлены callback (массив строк). При наличии `callbackUrl` и отсутствии `callbackEvents` в запросе, будет отправлен callback по событию `delivered`.
content.contentType*	string	Тип контента (всегда `text`)
content.text*	string	Текст сообщения, который будет зачитан абоненту. Должен соответствовать шаблону (описано ниже) От 1 до 1000 символов
ttl	integer	Время жизни сообщения в секундах. По истечении ttl сообщению присваивается финальный статус. `30``≤``ttl``≤``86400`
externalMessageId	string	Внутренний id сообщения в вашей системе. До 100 символов.

200

В случае успешного запроса возвращается ответ, в котором перечислены идентификаторы сообщений и коды результата. При значении errors = false гарантируется, что все переданные сообщения успешно созданы.

{
  "errors": false,
  "items": [
    {
      "messageUuid": "063474ec-a34f-4558-90c5-984395000004",
      "code": 201
    },
    {
      "messageUuid": "063564ec-a34f-4558-90c5-984395000005",
      "code": 201
    }
  ]
}

401

Использование невалидного токена / отсутствие заголовка авторизации.

4012

{
    "error": {
        "code": 4012,
        "msg": "Bad credentials"
    }
}

4010

{
    "error": {
        "code": 4010,
        "msg": "Not Authenticated"
    }
}

403

Использование неподходящего токена.

{
    "error": {
        "code": 4030,
        "msg": "Access Denied"
    }
}

422

Невалидные параметры в теле запроса; ниже приведены несколько примеров ответа.

{
    "error": {
        "code": 4220,
        "msg": "Invalid content"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Invalid msisdn"
    }
}

402

Payment Required. Недостаточно средств на балансе.

{
    "error": {
        "code": 402,
        "msg": "Insufficient funds"
    }
}

Совет

Рекомендуемое время ожидания ответа: 70 секунд.
Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.

Совет

Отправляемый текст должен соответствовать шаблону:
&#xNAN;Код авторизации от {Бренд}: {Код}
&#xNAN;Код авторизации от {Бренд}: {Код}. Повторяю: {Код}

Код может передаваться слитно (1234), с пробелом (1 2 3 4), разделяя спец.символом (1-2-3-4) - на качестве озвучки кода это не сказывается.

Для возможности отправки сообщений по другому шаблону вы можете обратиться к менеджеру
В качестве senderName нужно передавать значение voicecode

Возможные варианты перечислений:

Параметр	Варианты
callbackEvents	События для отправки callback

Пример запроса #

JSON

POST https://direct.i-dgtl.ru/api/v1/message
Authorization: Basic QWxhZGRpbjpvc...
Content-Type: application/json
[
  {
    "channelType": "VOICECODE",
    "senderName": "voicecode",
    "destination": "79999999999",
    "content": {
        "contentType": "text",
        "text": "Код авторизации от i-digital: 3 4 5 6"
    }
  }
]

cURL

curl -X POST 'https://direct.i-dgtl.ru/api/v1/message' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic QWxhZGRpbjpvc...' \
-d '[{"channelType":"VOICECODE","senderName":"voicecode","destination":"79999999999","content":{"contentType":"text","text":"Код авторизации от i-digital: 3 4 5 6"}}'

Python

import requests
import json

url = "https://direct.i-dgtl.ru/api/v1/message"

payload = json.dumps([
  {
    "channelType": "VOICECODE",
    "senderName": "voicecode",
    "destination": "79999999999",
    "content": {
      "contentType": "text",
      "text": "Код авторизации от i-digital: 3 4 5 6"
    }
  }
])
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

JavaScript

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify([
  {
    "channelType": "VOICECODE",
    "senderName": "voicecode",
    "destination": "79999999999",
    "content": {
      "contentType": "text",
      "text": "Код авторизации от i-digital: 3 4 5 6"
    }
  }
]);

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://direct.i-dgtl.ru/api/v1/message", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n  {\n    \"channelType\": \"VOICECODE\",\n    \"senderName\": \"voicecode\",\n    \"destination\": \"79999999999\",\n    \"content\": {\n      \"contentType\": \"text\",\n      \"text\": \"Код авторизации от i-digital: 3 4 5 6\"\n    }\n  }\n]");
Request request = new Request.Builder()
  .url("https://direct.i-dgtl.ru/api/v1/message")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

PHP

<?php
$client = new Client();
$headers = [
  'Content-Type' => 'application/json'
];
$body = '[
  {
    "channelType": "VOICECODE",
    "senderName": "voicecode",
    "destination": "79999999999",
    "content": {
      "contentType": "text",
      "text": "Код авторизации от i-digital: 3 4 5 6"
    }
  }
]';
$request = new Request('POST', 'https://direct.i-dgtl.ru/api/v1/message', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://direct.i-dgtl.ru/api/v1/message"
  method := "POST"

  payload := strings.NewReader(`[
  {
    "channelType": "VOICECODE",
    "senderName": "voicecode",
    "destination": "79999999999",
    "content": {
      "contentType": "text",
      "text": "Код авторизации от i-digital: 3 4 5 6"
    }
  }
]`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Совет

В примере указан минимальный набор параметров, который позволяет моментально отправить VOICECODE. Вы можете кастомизировать время отправки, настроить коллбэки, добавить теги и внутренний идентификатор, используя опциональные параметры, описанные выше на данной странице.