Перейти к содержанию

SendVoiceStatus#

Бета-версия

Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно. В будущем за функционал может взиматься дополнительная плата.

Метод предназначен для отправки голосового статуса.
Статус будет добавлен в очередь на отправку. Статус на отправку хранится 24 часа в очереди и будет отправлено сразу же после авторизации телефона.
Скорость отправки статусов из очереди регулирует параметр Интервал отправки сообщений.

Важно

Чтобы получатель увидел статусы отправителя, обе стороны должны сохранить номера собеседников в список контактов

Запрос#

Для отправки голосового статуса требуется выполнить запрос по адресу: 

POST {{APIUrl}}/waInstance{{idInstance}}/sendVoiceStatus/{{apiTokenInstance}}

Для получения параметров запроса APIUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры запроса#

Параметр Тип Обязательный Описание
urlFile string Да Ссылка на отправляемый аудио файл
fileName string Да Название файла. Должно содержать расширение файла. Требуется использовать кодировку UTF-8 без BOM. Поддерживаемые форматы: .mp3, .wav
backgroundColor string Нет Цвет фона сообщения. Значение по умолчанию: #FFFFFF. Пример сайта для получения значения цвета фона
participants array<string> Нет Массив строк с идентификаторами контактов, которым будет доступен статус. Если значение поля пустое,"participants": [], статус будет доступен всем контактам

В случаe добавления несуществующих номеров в поле participants статус не будет отправлен на эти номера

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

Отправка голосового статуса: 

{
    "urlFile": "https://my.site.com/audio/music.mp3",
    "fileName": "music.mp3",
    "backgroundColor": "#228B22",
    "participants": ["70000001234@c.us", "440000001234@c.us"] // статус будет доступен только указанным контактам
}

Ответ#

Поля ответа#

Поле Тип Описание
idMessage string Идентификатор отправленного сообщения

Пример тела ответа#

{
    "idMessage": "3EB0C767D097B7C7C030"
}

Ошибки SendVoiceStatus#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки.

Примеры кода#

import requests

url = "{{APIUrl}}/waInstance{{idInstance}}/sendVoiceStatus/{{apiTokenInstance}}"

payload = json.dumps({
"urlFile": "https://sw-media.storage. greenapi.net/1101000000/537157f6-4e24-4c4e-b5c6-9406c702f196.mp3",
"fileName": "music.mp3",
"backgroundColor": "#228B22",
"participants": [
    "70000001234@c.us", 
    "440000001234@c.us"
]
})
headers = {
'Content-Type': 'application/json'
}

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

print(response.text)

curl --location '{{APIUrl}}/waInstance{{idInstance}}/sendVoiceStatus/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "urlFile": "https://sw-media.storage. greenapi.net/1101000000/537157f6-4e24-4c4e-b5c6-9406c702f196.mp3",
    "fileName": "music.mp3",
    "backgroundColor": "#228B22",
    "participants": [
        "70000001234@c.us", 
        "440000001234@c.us"
    ]
}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{APIUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/sendVoiceStatus/")
    .append({{apiTokenInstance}});

var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

var jsonBody = "{\r\n\t    \"urlFile\": \"https://sw-media.storage. greenapi.net/1101000000/537157f6-4e24-4c4e-b5c6-9406c702f196.mp3\",\r\n\t    \"fileName\": \"music.mp3\",\r\n\t    \"backgroundColor\": \"#228B22\",\r\n\t    \"participants\": [\"70000001234@c.us\", \"440000001234@c.us\"]\r\n}";

var requestEntity = new HttpEntity<>(jsonBody, headers);

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append({{APIUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/sendVoiceStatus/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .body("{\r\n\t    \"urlFile\": \"https://sw-media.storage. greenapi.net/1101000000/537157f6-4e24-4c4e-b5c6-9406c702f196.mp3\",\r\n\t    \"fileName\": \"music.mp3\",\r\n\t    \"backgroundColor\": \"#228B22\",\r\n\t    \"participants\": [\"70000001234@c.us\", \"440000001234@c.us\"]\r\n}")
    .asString();

System.out.println(response);