API documentation

Login username (email address)

Login password

A code generated for new agents or when restoring a forgotten password. If the code matches, the specified password is used from now on for the agent. Or a code sent for 2-factor authentication.

Token with login data

Channel ID for activating this channel

The whatsapp number or email address to which the 2fa code will be sent, cannot be overwritten

Login username (email address)

The user ID, number or secret hash code. Multiple ids can be separated by comma.

The maximum number of results.

Active and inactive users are listed per default. Use 1 for listing only active users and 0 for listing only inactive users.

The number of skipped results.

Set to 1 for listing only blocked users

Set to 1 for listing only unreachable users

List only active users of this targeting group.

Users can be searched by id/phone number (if the search attribute is numeric) or by parts of their name or referral info.

User lists are ordered by creation date per default. stopped, id, name, messenger, blocked, last_chat, last_in or last_out can be specified to order by those attributes.

Normally user lists are sorted descending which means latest first.

Set if the time of the last user chat (incoming or outgoing) should be included.
Retrieving the information costs more time.

Set if the time of the last user chat (incoming) should be included.
Retrieving the information costs more time.

Set if the time of the last user chat (outgoing) should be included.
Retrieving the information costs more time.

Set if the last message (incoming or outgoing) should be included.
Not available when using tickets.

Set if the number of unread incoming chat messages should be included.
Not available when using tickets.

Set if custom fields should be included.

A JSON array of user filter. If multiple filters are specified, all are applied. Each filter element can have the following elements:

• type: mandatory type of the filter. Possible value is created or customfield
• after: UNIX timestamp of created or last update of a customfield
• before: UNIX timestamp of created or last update of a customfield
• name: name of a custom field (default all)
• value: Value of a custom field

List only users whose latest chats have been with the chatbot without a ticket

Possible values json or csv. Only applies for listing users.

The user ID, number or secret hash code. Multiple ids can be separated by comma.

Requires JSON with field name => field value.
Possible field names:

• name: name of the user
• customfields: Please see possible user properties by using the GET USER PROPERTIES call.
  Example:

  {  
  "name": "John Doe",  
  "customfields": {  
  "haircolor": "brown",  
  "123": "premium"  
  },  
  }  

Number of unread incoming chat messages. Not available when using tickets. Set 0 or the number of unread chat messages.
If unread is set for multiple users, the fields parameter is ignored. Also only the last message per user is marked as unread if unread is greater 1.

The CSV file containing the user list.
Only fields provided within the file will be handled
The following fields are possible:

• Regular fields:
  • id
    mandatory
    Id of the user, differs by messenger, for WhatsApp this would be the phone number
  • messenger
    mandatory
    Identifier for the used messenger of the user. Possible values: CC for Custom Messenger, FB for Facebook, IM for IMessage, IG for Instagram, RC for RCS, TG for Telegram, VI for Viber, WB for WhatsApp, IN for Notify
  • name
    Username
• Control fields:
  • activated
    1: user should be activated for MIA, 0: user should be deactivated for MIA
  • blocked
    1: user should be blocked, 0: user should be unblocked
  • deactivated
    1: user should be deactivated for MIA, 0: user should be activated for MIA
  • deleted:
    1: user should be deleted, 0: user should not be deleted
• Every user property of the channel listed by name

The user ID, number or secret hash code. Multiple IDs can be separated by comma.

The user ID, number or secret hash code. Multiple IDs can be separated by comma.

The user ID, number or secret hash code. Multiple IDs can be separated by comma.

The user ID, number or secret hash code. Multiple IDs can be separated by comma.

The user ID, number or secret hash code. Multiple IDs can be separated by comma.

The phone number of the user without blanks or leading + or 0, e.g 491771234567

Must be set to WB for creating a WhatsApp Business user

A comma-separated list of user numbers. Leave empty to list all users with the property.

The name of the user property

The user number. Multiple numbers can be separated by comma.

The name of the user property

The value of the user property. Must be compliant with the possible field values.

The field ID or name

Set to 1 if hidden fields should be included.

The name of the user property, no spaces. "fieldname" will result in a bot variable $fieldname$.

Possible types:

• number
• text
• word
• enum
• collection
• location
• date
• time

Possible values or conditions for this proeprty.
e.g. >=2 <=9 for type number.
a,b,c,d for type enumeration or collection

Expiration in seconds

• 0: won't be saved and can only be used in the answer associated with the input
• >0: Seconds before information will be purged
• -1: permanent

Property can be edited on the "profile page" by the user.

Display name of the property (also shown on users profile page)

The position of the property. Per default it is added at the end.

Property is not visible for agents.

Property is read only for agents.

Property is only visible with appropriate rights (not for normal agents).

Default value that is replaced if no value is stored in the user profile.

The field ID or name

The name of the user property, no spaces. "fieldname" will result in a bot variable $fieldname$.

Possible types:

• number
• text
• word
• enum
• collection
• location
• date
• time

Possible values or conditions for this property.
e.g. >=2 <=9 for type number.
a,b,c,d for type enumeration or collection

Expiration in seconds

• 0: won't be saved and can only be used in the answer associated with the input
• >0: Seconds before information will be purged
• -1: permanent

Property can be edited on the "profile page" by the user.

Display name of the property (also shown on users profile page)

The position of the property.

Property is not visible for agents.

Property is read only for agents.

Property is only visible with appropriate rights (not for normal agents).

Default value that is replaced if no value is stored in the user profile.

The property ID or name

The user ID, number or secret hash code. Multiple ids can be separated by comma.

This maximum number of results.

Show MIA start and stop messages of users.

The user ID, number or secret hash code. Multiple IDs can be separated by comma. The user number / id must be numeric only. Do not add a "+" to the user number (WhatsApp)

The text message to be sent.

The url of the attachment. The following types/extensions are supported: image (jpg, jpeg, png, gif), video (mp4, m4v, mpg, mpeg, mov, avi), audio (mp3, wav, ogg, opus) or document (pdf, docx, etc). If the attachment is valid, a field called reusable_attachment is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance. Can also contain json for sending product lists.

The filename of the attachment. It can be displayed in messengers that don't support inline view of the attachment.

A JSON encoded array of buttons can be passed. Each button must define a caption (displayed text), a type (link or postback) and an info field

• Link must contain a URL.
• Postback a text send back to the server when the user clicks on it
  Example:

  [  
  {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"},  
  {"type":"postback", "caption":"Hello","info":"Hello"}  
  ]  

  Note: Buttons are sent differently to the various messengers.

The parameter "meta" can contain any key => value pairs, that do not use reserved names. Mainly used for internal purposes

Array or comma-separated list of user numbers for sending to a larger number of users. Use instead of the id parameter. Performance-optimized so it does not update tickets of individual users. Just a list of success and failure numbers is returned.

Optional filter to use for sending in batch mode. Valid filters are all parameters given in endpoint USER GET.

The user ID, number or secret hash code. Multiple IDs can be separated by comma.

Array or comma-separated list of user numbers for sending to a larger number of users. Use instead of the id parameter. Performance-optimized so it does not update tickets of individual users. Just a list of success and failure numbers is returned.

Optional filter to use for sending in batch mode. Valid filters are all parameters given in endpoint USER GET.

The name of the notification template

A JSON array of parameters that are replaced in the notification.
For example: ["$profile_name$", "Value 2"]

The url of the header attachment. The following types/extensions are supported: image (jpg, png), video (mp4) or document (pdf). If the attachment is valid, a field called reusable_attachment is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance.

The text to be placed into the header variable

The suffix added to a dynamic link button

Language code of the notification, that should be send.
All available language codes can be found on the page https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates.

The user ID, number or secret hash code. Multiple IDs can be separated by comma.

The ID of the topic

The ID of the chat

JSON with field name => field valuepairs which will be set as user properties before sending. see possible user properties by using the GET USER PROPERTIES call.
Example: { "color": "red" }

Optional filter to use for sending in batch mode. Valid filters are all parameters given in endpoint USER GET.

The user ID, number or secret hash code.

1 if start typing, 0 for end typing

The id of the chat that should be deleted

Name of the channel

Status message of the channel

Welcome message for new users

Ticket message for existing users

Set if a read confirmation should be sent in WhatsApp when receving chat messages

Set to enable the linkpreview-feature in the messengers supporting link previews

Set to interpret every word as "Start" message. When disabled, only the default start word in the channels language or the specific start word is active.

When startword is set and every_word_starts is set to 0, users are only activated if they send this specific word

The timezone, e.g. "Europe/Berlin" or "America/Los_Angeles"

The amount of days after which inactive users are deleted automatically

Default language for this channel. Possible languages:
de, en, d1 (formal German), es, fr, it, nl, pl, pt, ru, r1, ar, tr, hr and jp

URL of the profile image of the channel

Time in minutes after which a ticket is marked as "overdue"

Time in minutes after which a ticket is marked as "critical"

Set if you want to open a ticket even if the chatbot answered already.

Time in minutes after which a ticket is reopened after it has been closed. Default 60

Time in minutes after which a ticket is closed automatically. Default 0

Set if you want to use autorouting of tickets.

Set if you want to assign tickets to agents automatically.

Set if you want to assign a ticket automatically to a previously assigned agent.

Set to 2 for automatically deactivating a bot when the agent sends a chat response or to 1 when a ticket is opened.

Any information in json format used by a frontend to store channel specific settings

The maximum number of tickets that are assigned to an agent by auto routing.

Set if you want to assign a ticket automatically only to online agents.

Set if you want to activate auto routing by keywords

Set if you want to open a ticket whenever the channel is mentioned in an Instagram story

Configuration for apple payment in json format (unused)

Set if you want to enable urltracking with shortened URLs. Contact MessengerPeople if you want to use your own domain instead of www.msgp.pl.

Parameters that are added to linked URLs if a user clicks on the link. %SOURCE% will be replaced by the used messenger

The number of unread MIA content messages a user gets when requesting MIA content.

The maximum age in seconds of unread MIA content messages a user gets when requesting content.

An array of default texts that can be used when sending MIA content

The message that a user gets when he tries to pull content but got already all content.

The channel image displayed in the Notify app.

A short text describing the channel in the Notify app.

Specifies whether channel content can be displayed in the chat of Notify.

The status of the channel in the Notify app affecting the visibility in the categories list. Possible values are public, private or hidden.

Welcome message for users subscribing for MIA content

Notify promotion text added for WhatsApp users subscribing for MIA content

Goodbye message for users who are unsubscribing

Link to the privacy policy

Specifies whether MIA content is pushed to messengers.

Specifies whether a reopened ticket should be de-assigned from an agent. Default 0

The number of days after which inactive Facebook users are stopped automatically

The number of days after which inactive Notify users are stopped automatically

Specifies whether agents can delete single chat messages.

Specifies whether a note is mandatory when closing a ticket.

The days and hours when the webchat is available. Provide data in JSON format with a
comma-separated list of weekdays as the key and a nested object with time-strings for from and to.
Default value is:

{"mon,tue,wed,thu,fri": {"from": "09:00", "to": "17:00"}}

Specifies whether ticket and chat events in other channels of the account are distributed to the agents.

The maximum number of results.

List only chat messages with a smaller or bigger ID, depending on the sorting.

List only chat messages with a chattime that is later.

Show incoming messages.

Show outgoing messages.

Include chat meta information

Only messages that contain this substring will be returned .

Show automated / bot messages if bot = 1. If bot = 2 include also welcome and stop messages.

Sort list with earliest first.

Get online agents from other channels of this account

The name of the label

The background color of the label in hex format, eg. BADA55

The text color of the label in hex format, eg. C0FFEE

The label ID. Multiple IDs can be separated by comma.

The name of the label

The background color of the label in hex format, eg. FACADE

The text color of the label in hex format, eg. BE1337

The label ID. Multiple IDs can be separated by comma.

Set if a confirm dialog should be displayed to new Facebook users

The text in the confirm dialog that new Facebook users are receiving.

Set if the Facebook "get started" button should be displayed to new users

The greeting message that Facebook users are receiving when sending the first message to the page.

The Facebook access token from an administrator connecting to a Facebook page.
For connecting the page the access_token, page_id and page_name must be set.
For disconnecting the page the access_token must be empty and page_id and page_name must be set.

The Facebook page ID

The Facebook page name

The URL of a webhook. All incoming messages will be pushed to this URL. It MUST return a JSON

{ "success": "true" }  

Otherwise the webhook will be deactivated after some failed attempts.

Set active (1) or inactive (0).

In case anything goes wrong, a notification will be sent to this email address.

Comma separated list of fields to be included in the webhook call.


Possible fields:

• id
• messenger
• usernumber
• date
• attachment
• attachment_type
• text
• welcome
• channelnumber
• userstatus
• chat_id
• bot_chatid
• is_retry
• ticket_id
• ticket_status
• agent_id

Default: "id,messenger,usernumber,date,attachment,attachment_type,text,welcome,channelnumber,userstatus,chat_id"

A test message is sent to the webhook to check whether everything works correctly.
If the parameter webhook_fields is set, the test data will be adjusted according to the field list
The push contains three messages (2 x WhatsApp, 1 x Facebook) in one call:

{  
"messages":[ {  
"id":"62103206",  
"messenger":"WB",  
"usernumber":"4917212345678",  
"date":"1522938174",  
"attachment":"",  
"attachment_type":"",  
"text":"Usermessage 1",  
"welcome":"0",  
"channelnumber":"4915792312345",  
"userstatus":"1",  
"chat_id":"1234567",  
"bot_chatid":"12345",  
"is_retry":"1"  
},  
{  
"id":"62103207",  
"messenger":"WB",  
"usernumber":"4917212345678",  
"date":"1522938174",  
"attachment":"",  
"attachment_type":"",  
"text":"Usermessage 2",  
"welcome":"0",  
"channelnumber":"4915792312345",  
"userstatus":"1",  
"chat_id":"1234568",  
"bot_chatid":"12345",  
"is_retry":"0"  
},  
{  
"id":"62103295",  
"messenger":"FB",  
"usernumber":"998694828505",  
"date":"1522938208",  
"attachment":"",  
"attachment_type":"",  
"text":"message via facebook",  
"welcome":"0",  
"userstatus":"1",  
"chat_id":"1234569",  
"bot_chatid":"12345",  
"is_retry":"0"  
} ] }  

If the user is activated successfully by sending the chat, the field welcome has the value 1.
The field userstatus has the value -1, 0 or 1.

• -1: The user sending the chat was delete
• 0: The user sending the chat is inactive
• 1: The user sending the chat is active

The ID of a single content.

List only drafts if filter = "draft", scheduled if filter = "scheduled", content that is already published if filter = "published", or published and scheduled content of today (timezone Europe/Berlin) if filter = "today".

The maximum number of results.

The number of results skipped in the result set.

Content lists are ordered by published date per default (creation date for drafts). created can be specified to order by this attribute.

Normally content lists are sorted descending which means latest first.

Specifies whether click statistics should be returned for URLs in contents. Requires enabled click tracking in the channel.
The result shows the total number of clicks and the number of clicks for each messenger.

Specifies whether reach statistics should be additionally split up in 'pulled from' and 'pushed to' for each messenger separately.

Specifies whether external content should be included.

Specifies whether sent/failed statistics for targeted users should be displayed. For each content and user it is displayed whether the sending was successful,
failed because the user is unreachable or any other error happened

The text of the content.

The url of a media attachment. The following types/extensions are supported: image (jpg, jpeg, png, gif), video (mp4, m4v, mpg, mpeg, mov, avi), audio (mp3, wav, ogg, opus) or document (pdf, docx etc).

The original filename of the attachment.

A JSON encoded array of user ids receiving the content grouped by messenger, e.g. {"WB" : [4912345678, 49234567890]}

The name of the notification template

A JSON array of parameters that are replaced in the notification

The url of the header attachment. The following types/extensions are supported: image (jpg, png), video (mp4) or document (pdf). If the attachment is valid, a field called reusable_attachment is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance.

The text to be placed into the header variable

The suffix added to a dynamic link button

Language code of the notification, that should be send.
All available language codes can be found on the page https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates.

The text of the content.

The url of a media attachment. The following types/extensions are supported: image (jpg, jpeg, png, gif), video (mp4, m4v, mpg, mpeg, mov, avi), audio (mp3, wav, ogg, opus) or document (pdf, docx etc).

The original filename of the attachment.

If set, store the content as draft, otherwise it will be published.

The UNIX timestamp of the publication date in seconds (if not a draft). The current date is used per default.

A short text that is sent to inform the users about new content. This text is sent to the Notify app or to WhatsApp, if the user has no Notify app.

If specified this link is opened directly from notifications in the Notify app. Other messengers will get the text + this weblink.

A JSON encoded array of buttons can be passed. Each button must define a caption (displayed text), a type (link or postback) and an info field

• Link must contain a URL.
• Postback a text send back to the server when the user clicks on it
  Example:

  [  
  {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"},  
  {"type":"postback", "caption":"Hello","info":"Hello"}  
  ]  

  Note: Buttons are sent differently to the various messengers.

MIA topic ID 1-10 or ID of a targeting list.

The lifetime of the content after publishing in seconds.

The pull keyword used for pulling the content in WhatsApp.

The name of the notification template

A JSON array of parameters that are replaced in the notification

The url of the header attachment. The following types/extensions are supported: image (jpg, png), video (mp4) or document (pdf). If the attachment is valid, a field called reusable_attachment is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance.

The text to be placed into the header variable

The suffix added to a dynamic link button

Language code of the notification, that should be send.
All available language codes can be found on the page https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates.

A targeting query to be used instead of a targeting_id.

Resending to failed users of another content. Content can be adapted

The content ID

The text of the content.

The url of a media attachment. The following types/extensions are supported: image (jpg, jpeg, png, gif), video (mp4, m4v, mpg, mpeg, mov, avi), audio (mp3, wav, ogg, opus) or document (pdf, docx etc).

The original filename of the attachment.

If set, store the content as draft, otherwise it will be published.

The UNIX timestamp of the publication date in seconds (if not a draft). The current date is used per default.

A special notification text sent to the Notify app.

If specified this link is opened directly from notifications in the Notify app. Other messengers will get the text + this weblink.

A JSON encoded array of buttons can be passed. Each button must define a caption (displayed text), a type (link or postback) and an info field

• Link must contain a URL.
• Postback a text send back to the server when the user clicks on it
  Example:

  [  
  {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"},  
  {"type":"postback", "caption":"Hello","info":"Hello"}  
  ]  

  Note: Buttons are sent differently to the various messengers.

Category ID 1-10 or ID of a targeting list.

The lifetime of the content after publishing in seconds.

The pull keyword used for pulling the content in WhatsApp.

The name of the notification template

A JSON array of parameters that are replaced in the notification

The url of the header attachment. The following types/extensions are supported: image (jpg, png), video (mp4) or document (pdf). If the attachment is valid, a field called reusable_attachment is in the result, containing a cached URL for the sent file. Use this URL the next time for sending the same file to other users to improve the performance.

The text to be placed into the header variable

The suffix added to a dynamic link button

Language code of the notification, that should be send.
All available language codes can be found on the page https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates.

A targeting query to be used instead of a targeting_id.

The ID of the content.

The ID of a single targeting group

Status Filter. Use 1 for listing only targeting groups that dont use a status filter and 0 for listing targeting groups that filter inactive users.

The targeting id

The name of the targeting group

A JSON array of the targeting group configuration

The name of the targeting group

A JSON array of the targeting group configuration

The ID of the targeting group

The targeting id

The targeting query.

Schema:
{"query": {

"condition": "OR",

"rules": [{

"id": "messenger",

"field": "messenger",

"type": "string",

"input": "select",

"operator": "equal",

"value": "FB"

}]}}

The targeting id

Group the result by messenger

The targeting query.

Schema:
{"query": {

"condition": "OR",

"rules": [{

"id": "messenger",

"field": "messenger",

"type": "string",

"input": "select",

"operator": "equal",

"value": "FB"

}]}}

The name of the template

Synchronize templates with WhatsApp before listing

The name of the template

The category of the template
Valid values: 'ACCOUNT_UPDATE', 'PAYMENT_UPDATE', 'PERSONAL_FINANCE_UPDATE', 'SHIPPING_UPDATE', 'RESERVATION_UPDATE', 'ISSUE_RESOLUTION', 'APPOINTMENT_UPDATE', 'TRANSPORTATION_UPDATE', 'TICKET_UPDATE', 'ALERT_UPDATE', 'AUTO_REPLY'

An array of translations with the following JSON structure. Language and body_text are mandatory. Header parameter depend on the header type:

[  
"en_US": {  
  "language": "en_US",  
  "body_text": "Text of the notification with parameter {{1}}",  
  "header_type": "TEXT", <- one of TEXT, MEDIA  
  "header_text": "Header text with parameter {{1}}",  
  "header_media_type": "IMAGE", <- one of IMAGE, DOCUMENT, VIDEO, LOCATION  
  "footer_text": "Footer text",  
  "buttons": [ { <- up to 3 QUICK_REPLY buttons OR a URL and/or PHONE_NUMBER button  
    "type": "QUICK_REPLY", <- one of QUICK_REPLY, URL, PHONE_NUMBER  
    "text": "Button caption", <-  
    "url": "https://foo.com/{{1}}", <- only for type URL. Parameter is optional.  
    "phone_number": "0123456789", <- only for type PHONE_NUMBER  
  } ],  
  "sample": { <- sample data that helps WhatsApp in reviewing the template  
    "body_variables": [ <- one for each used body variable  
      "My variable 1",  
    ],  
    "header_media": "URL of media file",  
    "header_variable": "My header variable",  
    "button_variable": "Variable for dynamic URL button",  
  },  
}

In-App visibility of the template

The id of the template

The name of the template. Can only be changed if all translations are still in status DRAFT.

The category of the template
Valid values: 'ACCOUNT_UPDATE', 'PAYMENT_UPDATE', 'PERSONAL_FINANCE_UPDATE', 'SHIPPING_UPDATE', 'RESERVATION_UPDATE', 'ISSUE_RESOLUTION', 'APPOINTMENT_UPDATE', 'TRANSPORTATION_UPDATE', 'TICKET_UPDATE', 'ALERT_UPDATE', 'AUTO_REPLY'
Can only be changed if all translations are still in status DRAFT.

An array of translations with the following JSON structure. language and body_text are mandatory. Header parameter depend on the header type:

[  
"en_US": {  
  "id": 12345, <- ID of existing translation  
  "language": "en_US",  
  "body_text": "Text of the notification with parameter {{1}}",  
  "header_type": "TEXT", <- one of TEXT, MEDIA  
  "header_text": "Header text with parameter {{1}}",  
  "header_media_type": "IMAGE", <- one of IMAGE, DOCUMENT, VIDEO, LOCATION  
  "footer_text": "Footer text",  
  "buttons": [ { <- up to 3 QUICK_REPLY buttons OR a URL and/or PHONE_NUMBER button  
    "id": 12345, <- ID of existing button  
    "type": "QUICK_REPLY", <- one of QUICK_REPLY, URL, PHONE_NUMBER  
    "text": "Button caption", <-  
    "url": "https://foo.com/{{1}}", <- only for type URL. Parameter is optional.  
    "phone_number": "0123456789", <- only for type PHONE_NUMBER  
  } ],  
  "sample": { <- sample data that helps WhatsApp in reviewing the template  
    "body_variables": [ <- one for each used body variable  
      "My variable 1",  
    ],  
    "header_media": "URL of media file",  
    "header_variable": "My header variable",  
    "button_variable": "Variable for dynamic URL button",  
  },  
}]

In-App visibility of the template

The name of the template

The name of the template

The id of the template

The name of the template. Can only be changed if all translations are still in status DRAFT.

The category of the template
Valid values: 'ACCOUNT_UPDATE', 'PAYMENT_UPDATE', 'PERSONAL_FINANCE_UPDATE', 'SHIPPING_UPDATE', 'RESERVATION_UPDATE', 'ISSUE_RESOLUTION', 'APPOINTMENT_UPDATE', 'TRANSPORTATION_UPDATE', 'TICKET_UPDATE', 'ALERT_UPDATE', 'AUTO_REPLY'
Can only be changed if all translations are still in status DRAFT.

An array of translations with the following JSON structure. language and body_text are mandatory. Header parameter depend on the header type:

[  
"en_US": {  
  "id": 12345, <- ID of existing translation  
  "skip": true, <- skip this translation from review  
  "language": "en_US",  
  "body_text": "Text of the notification with parameter {{1}}",  
  "header_type": "TEXT", <- one of TEXT, MEDIA  
  "header_text": "Header text with parameter {{1}}",  
  "header_media_type": "IMAGE", <- one of IMAGE, DOCUMENT, VIDEO, LOCATION  
  "footer_text": "Footer text",  
  "buttons": [ { <- up to 3 QUICK_REPLY buttons OR a URL and/or PHONE_NUMBER button  
    "id": 12345, <- ID of existing button  
    "type": "QUICK_REPLY", <- one of QUICK_REPLY, URL, PHONE_NUMBER  
    "text": "Button caption", <-  
    "url": "https://foo.com/{{1}}", <- only for type URL. Parameter is optional.  
    "phone_number": "0123456789", <- only for type PHONE_NUMBER  
  } ],  
  "sample": { <- sample data that helps WhatsApp in reviewing the template  
    "body_variables": [ <- one for each used body variable  
      "My variable 1",  
    ],  
    "header_media": "URL of media file",  
    "header_variable": "My header variable",  
    "button_variable": "Variable for dynamic URL button",  
  },  
}]

In-App visibility of the template

The name of the template

The language of the translation

The name of the template

The language of the translation

The name of the template

The language of the translation

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Unit of period interval, expected values: days, months

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the timestamp of 2021-09-01

UNIX timestamp of the end of the period, defaults to now

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the beginning of the current month

UNIX timestamp of the end of the period, defaults to now

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Filter the source of the URLS used for the clicks. Possible values: chats, content

Output order of the click information in descending order. Possible values: time, clicks

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Unit of period interval, expected values: days, weeks

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Unit of period interval, expected values: days, weeks, months

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Period of invoice, expected values: invoicing_period, last_invoicing_period
If set, this will overrule the parameters 'from' and 'to'

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Period of invoice, expected values: invoicing_period, last_invoicing_period
If set, this will overrule the parameters 'from' and 'to'

Group monthly active users by messenger

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Return only the given KPI, run without to see all KPIs

Specify the source of the statistics, expected values: chats, tickets

Unit of period interval, expected values: hours, days, weeks

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Possible values json or csv.

UNIX timestamp of the start of the period, defaults to the last 30 days

UNIX timestamp of the end of the period, defaults to now

Period of invoice, expected values: invoicing_period, last_invoicing_period
If set, this will overrule the parameters 'from' and 'to'

Possible values json or csv.

Specifies whether only current values tickets_unassigned_total, tickets_open_total, tickets_open_answered and tickets_open_unanswered are listed which makes the call much faster.

Specifies the unit of the result. Possible values are hours, days, weeks.

UNIX timestamp of the day/hour at which to start the statistics.
Default: Current day for hour statistics, 30 days ago for days or weeks

UNIX timestamp at which to end the statistics.
Default: current time

Possible values json or csv.

Specifies whether day statistics should be returned.
Default: 1 unless hour is set.

Specifies whether hour statistics should be returned.

UNIX timestamp of the day/hour at which to start the statistics.
Default: Current day for hour statistics, 30 days ago for days

UNIX timestamp at which to end the statistics.
Default: current time

Possible values json or csv.

Specifies whether day statistics should be returned.
Default: 1 unless hour is set.

Specifies whether hour statistics should be returned.

UNIX timestamp of the day/hour at which to start the statistics.
Default: Current day for hour statistics, 30 days ago for days

UNIX timestamp at which to end the statistics.
Default: current time

Include bot statistics.

Include additional week statistics.

The entity ID.

The entity ID

The entity data instance ID

The entity ID

The entity data instance ID, if the id is missing a new instance is created.

JSON with identifiers and attribute/value pairs for the object. Attributes which are not defined for the entity are ignored.
The keywords which identify the entitiy (in a message) are collected in the identifiers array. A keyword must not contain a ",".
Example:

{  
"identifiers": [  "john", "doe" ],  
"name": "John Doe",  
"mail": "[email protected]"  
}  

The entity ID

The entity data instance ID

The widget ID. If omitted list all widgets.

The widget name.

The type ID of the widget

The widget title

The widget body text

Specifies whether a privacy check is displayed.

The widget privacy text.

The widget privacy link.

Requires JSON with a list of messengers used in the widget. info and link_text are optional
Example:

[ {  
"id": "WA",  
"link_text": "Please save the number",  
"info": "Please add the number to your contacts"  
} ]  

Requires JSON with a list of settings used in the widget. requires id and value
Example:

[  
{ "id": 1, "value": "FFFFAA" },  
{ "id": 5, "value": 14 }  
]  

Wdiget language. Per default the channel language is used.
de, en, es, fr, it, nl, pl, pt, ru, ar, tr, hr and jp

The widget ID

The widget name

The type ID of the widget

The widget title

The widget body text

Specifies whether a privacy check is displayed.

The widget privacy text

The widget privacy link

Requires JSON with a list of messengers used in the widget. info, link_text and sequence are optional
Example:

[ {  
"id": "WA",  
"link_text": "Please save the number",  
"info": "Please add the number to your contacts",  
"sequence": 1,  
} ]  

Requires JSON with a list of settings used in the widget. requires id and value
Example:

[  
{ "id": 1, "value": "FFFFAA" },  
{ "id": 5, "value": 14 }  
]

Wdiget language. Per default the channel language is used.
de, en, es, fr, it, nl, pl, pt, ru, ar, tr, hr and jp

The widget ID

Wdiget language. Per default the channel language is used.
de, en, es, fr, it, nl, pl, pt, ru, ar, tr, hr and jp

The widget setting name

The data type of the setting. Possible values are int, boolean, float, string, color.

The setting ID

The setting name

The data type of the setting. Possible values are int, boolean, float, string, color.

The setting ID

The ticket ID or user_id. Multiple ids can be separated by comma. If a user_id is specified the last ticket of that user is returned.

The number of results. The maximum is 500 if chats of the tickets are listed or 5000 if no chats are listed.

The number of tickets skipped in the result set.

Order the results by that field. Valid fields are 'id', 'closed', 'created', 'status', 'messenger', 'waiting_since', 'label_names', 'agent', 'last_chat', 'last_in', 'last_out'.

Define whether to order the resulting tickets descending or ascending.

The status of the tickets. 0 for closed tickets, 1 for opened tickets

List only tickets assigned to the calling agent or her team.

The ID of a user or comma-separated list of IDs.

The ID of an agent or comma-separated list of IDs.

The ID of a label or comma-separated list of IDs.

List bot chat messages of the ticket.

A filter for searching tickets. Searches can be performed for ticket numbers, user ids, text in chat and notes. Only tickets of users are listed that match the search filter.

A filter for listing only tickets of users with this messenger. Valid values are 'WA', 'WB', 'FB', 'TG', 'IN', 'IM', 'VI', 'IG', 'RC. (WA and WB are synonyms)

The maximum number of chats that are listed for each ticket .

A filter for listing only open tickets that are waiting since the specified time. Format: 0 for getting all answered, 1 for getting all unanswered tickets or from-to, e.g. 0-1552389233 or 1552389233-0 .

Set to 0 to avoid listing notes of the ticket(s) when ID is not specified.

List only new open tickets that have not been answered yet.

Include MIA content to the chat list of the tickets.

Include custom fields of the user to tickets.

A filter for listing only closed tickets that are closed within the specified time. Format: from-to, e.g. 0-1552389233 or 1552389233-0 .

Include timestamps (last_in/last_out) for last inbound and outbound chat

Only show postponed tickets

Hide tickets that are postponed to the future

The ID of the user

The ID of a user.

Reopen a closed ticket or create a new ticket.

The ID of a ticket or a user.

Add a note. Only possible if called by an agent.

Array or comma-separated list of ticket ids. Use instead of the id parameter.

Array or comma-separated list of labels.

The ID of a ticket or a user.

The ID of an agent, to sign this ticket to.

The ID of a team, to assign this ticket to.

The email address of an agent, to assign this ticket to. Only works if agent id and team id are not set.

Set if you want to activate or deactivate the chatbot for a ticket. Only relevant if the chat for the ticket is locked.

Mark a ticket as answered even if the user send the last chat by setting waiting_since to 0.

Array or comma-separated list of ticket ids. Use instead of the id parameter.

Timestamp to postpone the ticket(s) to.

The ID of a ticket or a user

The ID of a label

Array or comma-separated list of ticket ids. Use instead of the id parameter.

Array or comma-separated list of label ids. Use instead of the label_id parameter.

The ID of a ticket or a user

The ID of a label

The ID of a ticket

The note text

Agent ID to use instead of the currently logged-in agent's ID

The ID of a ticket

The ID of a note to update

The updated note text

The ID of a ticket

The ID of a note to update

ID of a ticket to get statistics from

UNIX timestamp of the day/hour after which tickets have been created. Default last 24 hours

UNIX timestamp of the day/hour before tickets have been created

This is the amount of results that is returned.

This is the amount of results skipped in the result set.

If specified return only one line for each ticket with information about the last assigned agent even if multiple agents had been assigned.

The id of the ticket

The output language. Possible values: 'en', 'de'

Result as JSON with the field pdf linking to an url

Include internal hidden user properties