POST запрос

С помощью POST запроса можно отправить больший объем информации в теле запроса в удобном формате. Поддерживается два типа данных: Text и JSON.

POST → JSON

Для отправки на указанный URL POST запроса с данными в структуре JSON, выберите следующее:

Для формирования тела JSON запроса вы можете использовать следующие параметры:

1. В «Доступные параметры» проставляя галочки напротив переменных, вы можете выбрать, какие из предложенных переменных попадут в тело запроса JSON. Если вы убираете галочку, то переменная в тело запроса не попадёт. Примеры переменных:

   • callerNumber — номер телефона абонента, который инициировал вызов;
   • accountid — уникальный идентификатор личного кабинета;
   • callId — уникальный идентификатор вызова;
   • billsec — продолжительность вызова в секундах;
   • timestamp — время, когда произошел вызов;
   • eventType — тип события, связанного с вызовом;
   • did — номер оператора, которому поступил вызов;
   • vpbxId — уникальный идентификатор ВАТС, куда поступил вызов;
   • answered — был ли ответ на вызов (0 или 1);
   • file — название файла факса;
   • InternalNumber — внутренний номер абонента, куда поступил вызов.

Если нажать на знак вопроса - то будет показан текст - описание информации, содержащейся в переменной.

2. В «Пользовательские параметры» вы можете добавить свои собственные ключи и соответствующие им значения или переменные.

3. В «Query параметры» также в формате ключ - значение вы можете передать Query параметры.

4. В «Заголовки» передайте свои заголовки (так называемые headers), если они необходимы.

• Как пример, мы заполнили поля: billsec, timestamp, eventType, InternalNumber.

В таком случае, будет сформирована следующая структура JSON:

{
    "billsec": "${{billsec}}",
    "timestamp": "${{timestamp}}",
    "eventType": "${{eventType}}",
    "InternalNumber": "${{InternalNumber}}",
    "Key": "Example"
 }

А придёт на указанный URL:

{
    "billsec": "6",
    "timestamp": "1687271174",
    "eventType": "VpbxInboundCallEnd",
    "InternalNumber": "100",
    "Key": "Example"
 }

Так как вместо переменных в формате ${{…}} подставятся значения этих переменных сгенерированных конкретным событием.

POST → Text

Для отправки на указанный URL POST запроса с типом данных Text, выберите следующее:

Для формирования запроса, вам доступны следующие параметры:

1. В секции «Доступные параметры», вы можете выбрать переменные, генерируемые в следствии возникновения выбранного события. В кружках с вопросительными знаками хранится описание переменных, а продолговатые синие элементы с названиями переменных интерактивны. При наведении курсора на текстовое поле, а затем и нажатия на любую переменную, она в нужном формате вставится в ту часть текстового поля где стоит курсор, а также скопируется в буфер обмена.  
   
   

2. В секции «Тело запроса» находится текстовое поле в которое в вольном формате можно передавать свою структуру данных, которая в итоге отправится на выбранный URL. Также, не забывайте, что если вы хотите передать в своей вольной структуре какую-либо из предоставленных переменных, просто воспользуйтесь советом из пункта выше.   
   
   

3. В секции «Query параметры» в формате ключ - значение вы можете передать Query параметры.

   ✅ Примечание: Рекомендуется передавать query параметры с помощью GET запроса.

    

4. В секции «Заголовки» передайте свои заголовки (так называемые headers), если они необходимы.

   ⚠️ Внимание! В поле для ключа нельзя вставлять переменную, так как это вызовет ошибку и веб-хук не будет работать. Передавайте переменные в соседнем поле для значения.

     

Также см.:

«Веб-хуки»

«GET запрос»