Ziņu veidi

Deviņi ziņu veidi, viens pieprasījuma pamatteksts

Sūtīšanas pieprasījumā norāda kanālu, saņēmēju un veidu, bet saturs atrodas zem atslēgas, kuras nosaukums sakrīt ar veidu. Šajā lapā parādīts katrs veids, pamatteksts, kas to izveido, un kanāli, kuros tas tiek atbalstīts.

Atvērt API uzziņu Salīdzināt kanālus

Atbalsta matrica

Kurš kanāls pieņem kuru veidu

Kanāls laukā capabilities norāda, ko tas pieņem. Ja nosūta veidu, ko kanāls neatbalsta, tiek atgriezta kļūda 400 unsupported_message_type un maksa netiek ieturēta.

Ziņu veidu atbalsts pa kanālu veidiem
Veids	WhatsApp	SMS	SMS OTP	Telegram	Messenger	Instagram	TikTok
Teksts`text`	Atbalstīts	Atbalstīts	Atbalstīts	Atbalstīts	Atbalstīts	Atbalstīts	Atbalstīts
Pielikumi`attachments`	Atbalstīts	Atbalstīts	Nav atbalstīts	Atbalstīts	Atbalstīts	Atbalstīts	Atbalstīts
Veidne`template`	Atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts
Atbildes pogas`button`	Atbalstīts	Nav atbalstīts	Nav atbalstīts	Atbalstīts	Atbalstīts	Atbalstīts	Atbalstīts
Saraksts`list`	Atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts
URL poga`cta_url`	Atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts
Atrašanās vieta`location`	Atbalstīts	Nav atbalstīts	Nav atbalstīts	Atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts
Kontaktpersonas`contacts`	Atbalstīts	Nav atbalstīts	Nav atbalstīts	Atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts
Aptauja`poll`	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts	Atbalstīts	Nav atbalstīts	Nav atbalstīts	Nav atbalstīts

type: "text"

Teksts

Vienkāršs teksts, ko pieņem visi kanālu veidi. Iestatiet preview_url, lai kanāls attēlotu saites priekšskatījumu.

body: no 1 līdz 4096 rakstzīmēm.

WhatsApp Business
SMS
SMS OTP
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Jūsu pasūtījums #1042 ir izsūtīts. Sekojiet tam šeit: https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}

type: "attachments"

Pielikumi

Viens multivides vienums katrā ziņā, norādīts ar https URL: attēls, video, dokuments, audio, balss ziņa vai uzlīme, ar neobligātu parakstu.

Tieši viens vienums. caption: līdz 1024 rakstzīmēm.

WhatsApp Business
SMS
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "attachments",
  "attachments": [
    {
      "type": "image",
      "url": "https://example.com/receipts/1042.jpg",
      "caption": "Jūsu kvīts par pasūtījumu #1042."
    }
  ]
}

type: "template"

Veidne

Apstiprināta WhatsApp veidne ar mainīgajiem. Veidnes ir vienīgās ziņas, ko WhatsApp pieņem ārpus 24 stundu klientu apkalpošanas loga.

name un language jāatbilst kādai apstiprinātai kanāla veidnei.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "template",
  "template": {
    "name": "order_out_for_delivery",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Anna"
          },
          {
            "type": "text",
            "text": "#1042"
          },
          {
            "type": "text",
            "text": "18:00"
          }
        ]
      }
    ]
  }
}

type: "button"

Atbildes pogas

Ziņa ar ne vairāk kā trim ātrajām atbildēm. Nospiestās pogas ID tiek atgriezts jūsu tīmekļa aizķerei notikumā message.received.

No 1 līdz 3 pogām. title: līdz 20 rakstzīmēm.

WhatsApp Business
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Jūsu galdiņš diviem ir rezervēts šovakar plkst. 19:30. Vai joprojām varēsiet ierasties?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Apstiprināt"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Pārcelt"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Atcelt rezervāciju"
          }
        }
      ]
    }
  }
}

type: "list"

Saraksts

Izvēlne, kas atveras ar vienu pogu un kuras rindas ir sagrupētas sadaļās ar virsrakstiem.

action.button: līdz 20 rakstzīmēm.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Kura komanda šodien var jums palīdzēt?"
    },
    "action": {
      "button": "Izvēlēties komandu",
      "sections": [
        {
          "title": "Komandas",
          "rows": [
            {
              "id": "orders",
              "title": "Pasūtījumi",
              "description": "Piegāde, preču atgriešana un atmaksa"
            },
            {
              "id": "billing",
              "title": "Norēķini",
              "description": "Rēķini un maksājumu veidi"
            },
            {
              "id": "technical",
              "title": "Tehniskais atbalsts",
              "description": "Iestatīšana un problēmu novēršana"
            }
          ]
        }
      ]
    }
  }
}

type: "cta_url"

URL poga

Ziņa ar vienu pogu, kas atver URL, – izsekošanas lapām, maksājumiem un pierakstīšanās saitēm.

Viena poga katrā ziņā.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Jūsu sūtījums ir ceļā. Sekojiet tam reāllaikā."
    },
    "action": {
      "parameters": {
        "display_text": "Sekot pasūtījumam",
        "url": "https://example.com/t/1042"
      }
    }
  }
}

type: "location"

Atrašanās vieta

Atzīme kartē ar nosaukumu un adresi, kas atveras saņēmēja karšu lietotnē.

latitude un longitude ir decimālgrādi.

WhatsApp Business
Telegram

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "location",
  "location": {
    "latitude": 25.2048,
    "longitude": 55.2708,
    "name": "Izņemšanas punkts",
    "address": "Sheikh Zayed Road, Dubaija"
  }
}

type: "contacts"

Kontaktpersonas

Viena vai vairākas kontaktpersonu kartītes. Masīvs tiek pārsūtīts kanālam bez izmaiņām, tāpēc tajā izmanto pakalpojumu sniedzēja kontaktpersonu formātu.

Piemērā parādīts WhatsApp kontaktpersonu formāts.

WhatsApp Business
Telegram

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "contacts",
  "contacts": [
    {
      "name": {
        "formatted_name": "Atbalsta dienests",
        "first_name": "Atbalsts"
      },
      "phones": [
        {
          "phone": "+971800123456",
          "type": "WORK"
        }
      ]
    }
  ]
}

type: "poll"

Aptauja

Telegram iebūvētā aptauja ar jautājumu un atbilžu variantiem.

Tikai Telegram.

POST /v1/messages

{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Kad mums piegādāt jūsu pasūtījumu?",
    "options": [
      "No rīta, 09:00–12:00",
      "Pēcpusdienā, 12:00–17:00",
      "Vakarā, 17:00–21:00"
    ]
  }
}

Izmēģiniet visus veidus smilškastē

Katram kontam ir smilškastes kanāls katram kanāla veidam. Ar testa atslēgu nosūtiet jebkuru veidu, ko tas atbalsta, – nekas netiek piegādāts, un par to nav jāmaksā.

Saņemt API atslēgu Lasīt dokumentāciju