Изменение входящей загрузки по тарифам на переговоры – Gupshup

Текущая полезная нагрузка отправленного входящего сообщения-события

{
  "app": "DemoAPI",
  "timestamp": 1585344475993,
  "version": 2,
  "type": "message-event",
  "payload": {
    "id": "gBEGkYaYVSEEAgnZxQ3JmKK6Wvg",
    "gsId": "ee4a68a0-1203-4c85-8dc3-49d0b3226a35",
    "type": "sent",
    "destination": "918x98xx21x4",
    "payload": {
      "ts": 1585344475
    }
  }
}

Предлагаемая реализация полезной нагрузки отправленного сообщения-события после CBP

{
  "app":"DemoAPI",
  "timestamp":1580546677791,
  "version":2,
  "type":"message-event",
  "payload":{
      "id":"59f8db90-c37e-4408-90ab-cc54ef8246ad",
      "gsId":"ee4a68a0-1203-4c85-8dc3-49d0b3226a35",
      "type":"sent",
      "destination":"91XX985XX10X",
      "payload":{
        "ts":1585344475
      },
"conversation":{
        "id":"532b57b5f6e63595ccd74c6010e5c5c7",
        "expiresAt":1518780636,
        "type":"FEP/UIC/BIC"
      },
      "pricing":{
        "policy":"CBP/NBP",
        "category":"FEP/UIC/BIC"
      }
  }
}

Мы понимаем, что оплачиваемый параметр важен, и поэтому мы ввели новое событие, которое вы получите на свой URL-адрес обратного вызова, известное как событие выставления счетов. Событие выставления счетов описано внизу этой статьи.

Описание объекта переговоров

Ключ	Тип	Описание	Пример
id	string	Уникальный идентификатор переговоров	532b57b5f6e63595ccd74c6010e5c5c7
expiresAt	number	Временная метка окончания переговоров в секундах	1518780636
type	string	Тип переговоров Возможные значения: FEP (Свободная точка входа) UIC (Переговоры инициированы пользователем) BIC (Переговоры инициированы бизнесом)	FEP

Описание объекта тарифа

Ключ

Тип

Описание

Пример

policy

string

Тарифная политика для данного сообщения. Возможные значения:

CBP (Тариф на основе переговоров)
NBP (Тариф на основе уведомлений)

CBP

Новое событие обратного вызова: billing-event

{
  "app": "DemoAPI",
  "timestamp":1580546677791,
  "version":2,
  "type": "billing-event",
  "payload":{
     "deductions":{
       "type": "FEP/UIC/BIC/FTC",
       "model": "NBP/CBP",
       "source": "whatsapp"
       "billable": "true/false"
     },
     "references":{
       "id":"59f8db90c37e-4408-90ab-cc54ef8246ad",
       "gsId":"ee4a68a0-1203-4c85-8dc3-49d0b3226a35",
       "conversationId":"532b57b5f6e63595ccd74c6010e5c5c7",
       "destination":"91XX985XX10X"
      }
   }
}

Примечание: Вы начнете получать отметку «billable» в billable событии с 1 марта.

Описание объекта deductions

Ключ	Тип	Описание	Пример
type	string	Тип разговора. Возможные значения: FEP (бесплатная точка входа) UIC (разговор, инициированный пользователем) BIC (деловой разговор) FTC (Беседа уровня бесплатного пользования)	FEP/UIC/BIC
model	string	Модель ценовой политики, примененная к этому сообщению. Возможные значения: CBP (ценообразование на основе разговора) NBP (ценообразование на основе уведомлений)	NBP/CBP
source	string	Исходный источник разговора	whatsapp
billable	Boolean	Это значение либо истинно, либо ложно, в зависимости от того, является ли разговор оплачиваемым или нет.	false

Описание объекта references

Ключ	Тип	Описание	Пример
id	string	Уникальный идентификатор WhatsApp для сообщения	59f8db90c37e-4408-90ab-cc54ef8246ad
gsId	string	Уникальный идентификатор Gupshup для сообщения	ee4a68a0-1203-4c85-8dc3-49d0b3226a35
conversationId	string	Уникальный идентификатор беседы	532b57b5f6e63595ccd74c6010e5c5c7
destination	string	Номер телефона пользователя, участвующего в беседе. Номер телефона будет в формате E.164.	91XX985XX10X

Примечания:

После введения тарифов на переговоры, бизнесы будут получать новую загрузку "сообщение-событие", с дополнительными свойствами: переговоры и тарифы.
Только событие DLR: sent (это событие указывает на то, что сервер WhatsApp получил сообщение) позволит вам получить дополнительные сведения о тарифах на переговоры.
Порядок этих уведомлений в вашем приложении может не отражать фактическое время статуса сообщения. При необходимости просмотрите метку времени, чтобы определить время.