API documentation
Base-URL
https://rest.messengerpeople.com/api/v14/<endpoint>
login
-
POST Login
/login
https://rest.messengerpeople.com/api/v14/login
Create an API token for this user, that can be used instead of the API key to identify the users actions.
Parameter Value Type Description string Login username (email address)
password Login password
string The type of channels accessed by the logged in user. Possible values are
cs
for customer-service channels, andnl
for newsletter channels. Leave empty for listing all channels.string 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.
string Token with login data
string Channel ID for activating this channel
string The whatsapp number to which the 2fa code will be sent, cannot be overwritten
-
POST Password Code
/login/code
https://rest.messengerpeople.com/api/v14/login/code
Generate a code that is sent to the email address of the agent for restoring a forgotten password.
Parameter Value Type Description string Login username (email address)
-
DELETE Login
/login
https://rest.messengerpeople.com/api/v14/login
Logout a user who previously logged in
This method has no parameters.
user
-
GET Details
/user/{id}
https://rest.messengerpeople.com/api/v14/user/{id}
Get basic informations about one or multiple users. If the id is omitted users can be listed using various filters.
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple ids can be separated by comma.
integer This is the amount of results that is returned.
boolean(0/1) Active and inactive users are listed per default. Use
1
for listing only active users and0
for listing only inactive users.integer This is the amount of results skipped in the result set.
boolean(0/1) Set to
1
for listing only blocked usersinteger List only active users of this targeting group.
string Users can be searched by id/phone number (if the search attribute is numeric) or by parts of their name or referral info.
string User lists are ordered by creation date per default.
stopped
,id
,name
,messenger
,blocked
orlast_chat
can be specified to order by those attributes.boolean(0/1) Normally user lists are sorted descending which means latest first.
boolean(0/1) Set if the time of the last user chat should be included.
Retrieving the information costs more time.boolean(0/1) Set if custom fields should be included.
json 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 iscreated
orcustomfield
after
: UNIX timestamp of created or last update of a customfieldbefore
: UNIX timestamp of created or last update of a customfieldname
: name of a custom field (default all)value
: Value of a custom field
boolean(0/1) Only list users who have latest been chatting with the chatbot without having a ticket
-
PUT Data
/user/{id}
https://rest.messengerpeople.com/api/v14/user/{id}
Update data of a specific user
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple ids can be separated by comma.
json Requires JSON with
field name
=>field value
.
Possible field names:name
: name of the useragent
: email-address of an agent that should be assignedcustomfields
: Please see possible user properties by using the GET USER PROPERTIES call.
Example:{ "name": "John Doe", "agent": "john.doe@foo.bar", "customfields": { "haircolor": "brown", "123": "premium" }, "addlabel": [1,2,3], "removelabel": [4,5,6] }
-
POST Upload CSV
/user/csv
https://rest.messengerpeople.com/api/v14/user/csv
Bulk update users by uploading a csv file.
Since V13 also bulk create users is possible
This is not a JSON Request, please use the default HTTP Multi Part RequestParameter Type Description file 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 contact, differs by messengers, for WhatsApp for example this would be a phone number - messenger
mandatory
Identifier for the contacts messenger. Possible values: CC for Custom Messenger, FB for Facebook, IM for IMessage, TG for Telegram, VI for Viber, WB for WhatsApp, WN for Notify - name
Username of the contact
- id
- 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
- activated
- Every user property which is set up for your channel, by the name of the property
- Regular fields:
-
DELETE Delete
/user/{id}
https://rest.messengerpeople.com/api/v14/user/{id}
Delete the user and his chats. Chats and information about the user are deleted immediately after this call. The user itself is scheduled for deletion and will be deleted completely during the next 2hours afer being removed from broadcast lists etc.
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
-
PUT Start
/user/{id}/start
https://rest.messengerpeople.com/api/v14/user/{id}/start
Activate a user that was previously deactivated
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
-
PUT Stop
/user/{id}/stop
https://rest.messengerpeople.com/api/v14/user/{id}/stop
Deactivate a user
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
-
PUT Block
/user/{id}/block
https://rest.messengerpeople.com/api/v14/user/{id}/block
Block a user
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
-
PUT Unblock
/user/{id}/unblock
https://rest.messengerpeople.com/api/v14/user/{id}/unblock
Unblock a user that was previously blocked
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
-
GET Categories
/user/{id}/categories
https://rest.messengerpeople.com/api/v14/user/{id}/categories
Get categories of a user
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
-
PUT Categories
/user/{id}/categories
https://rest.messengerpeople.com/api/v14/user/{id}/categories
Set categories of a user
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
integer The category ID.
boolean(0/1) Set active (
1
) or inactive (0
). -
POST Note
/user/{id}/note
This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/user/{id}/note
Add a note to the user
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
string The content of the note you want to add to the user
-
GET Property
/user/property
https://rest.messengerpeople.com/api/v14/user/property
Get a user property for a list of users
Parameter Value Type Description string A comma-separated list of user numbers. Leave empty to list all users with the property.
string The name of the user property
-
PUT Property
/user/property
https://rest.messengerpeople.com/api/v14/user/property
Set a user property for a list of users
Parameter Value Type Description string The user number. Multiple numbers can be separated by comma.
string The name of the user property
string The value of the user property. Must be compliant with the possible field values.
User properties
-
GET User properties
/custom/{id}
https://rest.messengerpeople.com/api/v14/custom/{id}
Get all user properties
Parameter Value Type Description mixed The field ID or name
boolean(0/1) Set to 1 if hidden fields should be included.
-
POST User Property
/custom
https://rest.messengerpeople.com/api/v14/custom
Add a new user property
Parameter Value Type Description string The name of the user property, no spaces.
"fieldname"
will result in a bot variable$fieldname$
.string Possible field types:
number
text
word
enum
collection
location
date
time
string Possible values or conditions for this field.
e.g.>=2 <=9
for field typenumber
.
a,b,c,d
for field typeenumeration
orcollection
integer 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
boolean(0/1) Field can be edited on the "profile page" by the user.
string Internal name for the variable (also shown on users profile page)
integer The position of the field. Per default it is added at the end.
boolean(0/1) Field is only visible with appropriate rights (not for normal agents).
string Default value that is replaced if no value is stored in the user profile.
-
PUT User Property
/custom
https://rest.messengerpeople.com/api/v14/custom
Edit a user property
Parameter Value Type Description mixed The field ID or name
string The name of the user property, no spaces.
"fieldname"
will result in a bot variable$fieldname$
.string Possible field types:
number
text
word
enum
collection
location
date
time
string Possible values or conditions for this field.
e.g.>=2 <=9
for field typenumber
.
a,b,c,d
for field typeenumeration
orcollection
integer 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
boolean(0/1) Field can be edited on the "profile page" by the user.
string Internal name for the variable (also shown on users profile page)
integer The position of the field.
boolean(0/1) Field is only visible with appropriate rights (not for normal agents).
string Default value that is replaced if no value is stored in the user profile.
-
DELETE User Property
/custom
https://rest.messengerpeople.com/api/v14/custom
Delete a user property
Parameter Value Type Description mixed The field ID or name
User-Chat
-
GET history
/chat
https://rest.messengerpeople.com/api/v14/chat
Get the last chat messages of a user. With version 6 or higher addional information for outgoing chat is returned. Especially the send_status with the following possible values (availability depending on the messenger): 0 = sending in progress, 1 = sent (in WhatsApp and Viber 1= delivered), 2 = read, -1 = failed, -2 = user rejected, left the channel or 24 hour window is exceeded, 4 = Notification sent, 5 = Notification delivered, 6 = Notification read, -5 Notification failed, -6 Notification user does not exist
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple ids can be separated by comma.
integer This is the amount of results that is returned.
boolean(0/1) Show start and stop messages from users.
-
POST Send Message
/chat
https://rest.messengerpeople.com/api/v14/chat
Send a message to a user or to multiple users
Parameter Value Type Description mixed 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)
string The text message to be send to the user. Sending an attachment with a message is only possible for image and video. Audio and document will ignore the message.
url 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) 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.string The filename of the attachment. It can be displayed in messengers that don't support inline view of the attachment.
boolean(0/1) If set, mark the chat with this user as read (
1
) / unread (0
).json Buttons can be attached for all messengers except WhatsApp. A JSON encoded array of buttons can be passed. Each button must define a
caption
(displayed text), atype
(link, postback, call or share) and aninfo
field.- Link must contain a URL.
- Postback a text send back to the server when the user clicks on it
- Call a phone number
- Share a link that can be shared (Facebook only)
Example:[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]
array The parameter "meta" can contain any key => value pairs, that do not use reserved names. Mainly used for internal purposes
mixed 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.
json Optional filter to use for sending in batch mode. Valid filters are all parameters given in endpoint USER GET.
-
POST Send Notification
/chat/notification
https://rest.messengerpeople.com/api/v14/chat/notification
Send a notification to a user or to multiple users in WhatsApp Business
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
string The name of the notification
json A JSON array of parameters that are replaced in the notification
string ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter notification is set
mixed 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.
json Optional filter to use for sending in batch mode. Valid filters are all parameters given in endpoint USER GET.
string The name of the notification template
json A JSON array of parameters that are replaced in the notification.
For example: ["$profile_name$", "Value 2"]string 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.string The text to be placed into the header variable
string The suffix added to a dynamic link button
string Language Code of the notification, that should be send.
Defaults to the channel language if no default language for the notification template is set.
Mandatory if parameter notification_template is set.
All available Language Codes can be found on the page https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates. -
POST Bot Chat
/chat/bot
https://rest.messengerpeople.com/api/v14/chat/bot
Start a bot conversation with a user by sending a botchat. bot_active of the associated ticket will be set and the bot topic will be set. Conditions of the bot chat will not be evaluated. The first block of answer(s) will be used.
Parameter Value Type Description mixed The user ID, number or secret hash code. Multiple IDs can be separated by comma.
integer The ID of the topic
integer The ID of the chat
json JSON with
field name
=>field value
pairs which will be set as user properties before sending. see possible user properties by using the GET USER PROPERTIES call.
Example:{ "color": "red" }
-
DELETE Delete
/chat
https://rest.messengerpeople.com/api/v14/chat
Soft delete a single incoming chat by overwriting its text and remove all attachments
Parameter Value Type Description integer The id of the chat that should be deleted
channel
-
GET Details
/channel
https://rest.messengerpeople.com/api/v14/channel
Get basic information of the channel, that can be modified
This method has no parameters. -
PUT Details
/channel
https://rest.messengerpeople.com/api/v14/channel
Update basic information of the channel
Parameter Value Type Description string New name of the channel
string Status message of the channel
string Welcome message for new users
string Ticket message for existing users
boolean(0/1) Set if a read confirmation should be sent in WhatsApp when receving chat messages
boolean(0/1) Set to enable the linkpreview-feature in WhatsApp and Telegram
boolean(0/1) 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.
string When
startword
is set andevery_word_starts
is set to0
, users are only activated if they send this specific wordstring The timezone, e.g. "Europe/Berlin" or "America/Los_Angeles"
integer The amount of days after which inactive users are deleted automatically
string Default language for this channel. Possible languages:
de
,en
,d1
(formal German),es
,fr
,it
,nl
,pl
,pt
,ru
,r1
,ar
,tr
,hr
andjp
url URL of the profile image of the channel
integer Time in minutes after which a ticket is marked as "overdue"
integer Time in minutes after which a ticket is marked as "critical"
boolean(0/1) Set if you want to open a ticket even if the chatbot answered already.
integer Time in minutes after which a ticket is reopened after it has been closed. Default 60
integer Time in minutes after which a ticket is closed automatically. Default 0
boolean(0/1) Set if you want to use autorouting of tickets.
boolean(0/1) Set if you want to assign tickets to agents automatically.
boolean(0/1) Set if you want to assign a ticket automatically to a previously assigned agent.
integer Set to 2 for automatically deactivating a bot when the agent sends a chat response or to 1 when a ticket is opened.
string Any information in json format used by a frontend to store channel specific settings
integer The maximum number of tickets that are assigned to an agent by auto routing.
boolean(0/1) Set if you want to assign a ticket automatically only to online agents.
string Configuration for apple payment in json format
boolean(0/1) 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.
string Parameters that are added to linked URLs if a user clicks on the link. %SOURCE% will be replaced by the used messenger
boolean(0/1) Set if you want to add the categories info to the welcome message.
string The categories info that can be added to the welcome message. %LINK% will be replaced by a user specific link
boolean(0/1) Specifies whether notifications are used when sending content.
integer The number of unread information messages a user gets when requesting informations.
integer The maximum age in seconds of unread information messages a user gets when requesting informations.
string An array of default texts that can be used when sending information
string The message that a user gets when he tries to pull content but got already all content.
string The message that a user gets in Whatsapp in addition to a notification informing how to pull the content. {{1}} is replaced by the pull keyword.
string The initial text that an iOS user will send after installing the Notify app.
string The image displayed in the Notify app for the channel.
string A short text describing your channel visible in the Notify app.
boolean(0/1) Specifies whether channel content can be displayed in the chat of Notify.
string The status of the channel in the Notify app affecting the visibility in the categories list. Possible values are public, private or hidden.
string Additional Notify promotion text to send only to WhatsApp users without the Notify app.
string Welcome message for users subscribing for MIA content
string Notify promotion text added to for WhatsApp users subscribing for MIA content
string Goodbye message for users who are unsubscribing
string Link to the privacy manifest
boolean(0/1) Specifies whether MIA content is pushed to messengers.
boolean(0/1) Specifies whether a reopened ticket should not be assigned to an agent. Default 0
integer The amount of days after which inactive Facebook users are stopped automatically
integer The amount of days after which inactive Notify users are stopped automatically
boolean(0/1) Specifies whether the bot menu should be used.
boolean(0/1) Specifies whether agents can delete single chat messages.
boolean(0/1) Specifies whether or not a note is mandatory on ticket close.
-
GET Chats
/channel/chats
https://rest.messengerpeople.com/api/v14/channel/chats
Get the latest chat messages of the channel. With version 6 or higher addional information for outgoing chat is returned. Especially the send_status with the following possible values (availability depending on the messenger): 0 = sending in progress, 1 = sent (in WhatsApp and Viber 1= delivered), 2 = read, -1 = failed, -2 = user rejected, left the channel or 24 hour window is exceeded, 4 = Notification sent, 5 = Notification delivered, 6 = Notification read, -5 Notification failed, -6 Notification user does not exist
Parameter Value Type Description integer This is the amount of results that is returned.
integer ID of the first result to be served
boolean(0/1) Show incoming messages.
boolean(0/1) Show outgoing messages.
integer Show automated / bot messages if bot = 1. If bot = 2 include also welcome and stop messages.
-
GET Teams
/channel/teams
https://rest.messengerpeople.com/api/v14/channel/teams
Get the teams of the channel
This method has no parameters. -
POST Teams
/channel/teams
https://rest.messengerpeople.com/api/v14/channel/teams
Create a new team for a channel
Parameter Value Type Description string The name of the team
mixed The ID of an agent that should be added to the team. Multiple IDs can be separated by comma.
-
PUT Teams
/channel/teams
https://rest.messengerpeople.com/api/v14/channel/teams
Update teams of a channel
Parameter Value Type Description mixed The team ID. Multiple ids can be separated by comma.
string The name of the team
mixed The ID of an agent that should be added to the team. Multiple IDs can be separated by comma.
mixed The ID of an agent that should be removed from the team. Multiple IDs can be separated by comma.
-
DELETE Teams
/channel/teams
https://rest.messengerpeople.com/api/v14/channel/teams
Delete teams of a channel
Parameter Value Type Description mixed The team ID. Multiple IDs can be separated by comma.
-
GET Agents
/channel/agents
https://rest.messengerpeople.com/api/v14/channel/agents
Get the agents of the channel
This method has no parameters. -
GET Online agent IDs
V13/channel/online_agents
https://rest.messengerpeople.com/api/v14/channel/online_agents
Get a list of ids of online agents of the channel
This method has no parameters. -
GET Labels
/channel/labels
https://rest.messengerpeople.com/api/v14/channel/labels
Get the labels of the channel
This method has no parameters. -
POST Labels
/channel/labels
https://rest.messengerpeople.com/api/v14/channel/labels
Create a label for a channel
Parameter Value Type Description string The name of the label
string The background color of the label in hex format, eg.
BADA55
string The text color of the label in hex format, eg.
C0FFEE
-
PUT Labels
/channel/labels
https://rest.messengerpeople.com/api/v14/channel/labels
Update a label of a channel
Parameter Value Type Description mixed The label ID. Multiple IDs can be separated by comma.
string The name of the label
string The background color of the label in hex format, eg.
FACADE
string The text color of the label in hex format, eg.
BE1337
-
DELETE Labels
/channel/labels
https://rest.messengerpeople.com/api/v14/channel/labels
Delete labels of a channel
Parameter Value Type Description mixed The label ID. Multiple IDs can be separated by comma.
-
GET Facebook
/channel/facebook
https://rest.messengerpeople.com/api/v14/channel/facebook
Get Facebook connection info of the channel
This method has no parameters. -
PUT Facebook
/channel/facebook
https://rest.messengerpeople.com/api/v14/channel/facebook
Update Facebook confirmation and get-started information or (dis)connect to the Facebook page
Parameter Value Type Description boolean(0/1) Set if a confirm dialog should be displayed to new Facebook users
string The text in the confirm dialog that new Facebook users are receiving.
boolean(0/1) Set if the Facebook "get started" button should be displayed to new users
string The greeting message that Facebook users are receiving when sending the first message to the page.
string The Facebook access token from an administrator connecting to a Facebook page.
For connecting the page theaccess_token
,page_id
andpage_name
must be set.
For disconnecting the page theaccess_token
must be empty andpage_id
andpage_name
must be set.integer The Facebook page ID
string The Facebook page name
-
DELETE Facebook
/channel/facebook
https://rest.messengerpeople.com/api/v14/channel/facebook
Delete Facebook connection of a channel
This method has no parameters. -
GET Webhook
/channel/webhook
https://rest.messengerpeople.com/api/v14/channel/webhook
Get current webhook settings
This method has no parameters. -
PUT Webhook
/channel/webhook
https://rest.messengerpeople.com/api/v14/channel/webhook
Activate / Deactivate / Test Webhook An active WebHook will be used to inform an external system whenever a new chat message is sent from a user to a channel.
Parameter Value Type Description url 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.
boolean(0/1) Set active (
1
) or inactive (0
).email In case anything goes wrong, a notification will be sent to this email address.
string 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
Default: "id,messenger,usernumber,date,attachment,attachment_type,text,welcome,channelnumber,userstatus,chat_id"
boolean(0/1) A test message is sent to the webhook to check whether everything works correctly.
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 value1
.
The field userstatus has the value-1
,0
or1
.-1
: The user sending the chat was delete0
: The user sending the chat is inactive1
: The user sending the chat is active
If the parameter webhook_fields is set, the test data will be adjusted according to the field list
-
GET APIkey
/channel/apikey
https://rest.messengerpeople.com/api/v14/channel/apikey
Get the channel specific API key. This API key is valid until a new one is generated.
This method has no parameters. -
PUT APIkey
/channel/apikey
https://rest.messengerpeople.com/api/v14/channel/apikey
Generate a new API key. The previous API key is automatically invalidated.
This method has no parameters. -
GET Invoices
/channel/invoices
https://rest.messengerpeople.com/api/v14/channel/invoices
Returns all invoices and payment URLs
This method has no parameters. -
GET Features
/channel/features
https://rest.messengerpeople.com/api/v14/channel/features
This method has no parameters.
newsletter
-
GET History
/newsletter
https://rest.messengerpeople.com/api/v14/newsletter
Get your recent newsletters
Parameter Value Type Description integer This is the amount of results that is returned.
-
POST Send
/newsletter
This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/newsletter
Send a newsletter to users
Parameter Value Type Description string The text message to be send to the user. Sending an attachment with a message is only possible for image and video. Audio and document will ignore the message.
url 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) 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.datetime Time for sending in the timezone set for the channel. Leave empty if the newsletter should be send immediately. (Format
YYYY-mm-dd HH:ii
)integer Number of a category as seen in the backend (1–10)
integer ID of a targeting list. Cannot be combined with category. If the category is also set, this setting will be ignored.
json Buttons can be attached for all messengers except WhatsApp. A JSON encoded array of buttons can be passed. Each button must define a
caption
(displayed text), atype
(link, postback, call or share) and aninfo
field.- Link must contain a URL.
- Postback a text send back to the server when the user clicks on it
- Call a phone number
- Share a link that can be shared (Facebook only)
Example:[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]
-
DELETE Scheduled
/newsletter
https://rest.messengerpeople.com/api/v14/newsletter
Delete a scheduled newsletter by ID
Parameter Value Type Description integer The ID of the newsletter that should be deleted. Only scheduled newsletter can be deleted when sending hasn't started yet.
-
GET Targeting List
/newsletter/targeting
https://rest.messengerpeople.com/api/v14/newsletter/targeting
Get all targeting lists - For targeting setup please use the endpoint "Targeting"
Parameter Value Type Description integer The ID of a targeting list. Filter for getting only this targeting information in the result.
boolean(0/1) Set if count of users for the targeting list should be calculated. From version 11, this only works if requesting a specific targeting (id > 0).
boolean(0/1) Set if the targeting should include categories for content sending. From version 11, this only works if id not set.
-
GET Category
/newsletter/category
https://rest.messengerpeople.com/api/v14/newsletter/category
Get all categories
This method has no parameters. -
PUT Category
/newsletter/category
https://rest.messengerpeople.com/api/v14/newsletter/category
Rename category
Parameter Value Type Description integer The ID 1-10 of a category
string The new name of the category. Maximum length of the name is 100 characters.
-
POST Category
/newsletter/category
https://rest.messengerpeople.com/api/v14/newsletter/category
Create a new category. Users are assigned if categories_auto_assign is enabled at the channel
Parameter Value Type Description string The name of the new category. Maximum length of the name is 100 characters.
-
DELETE Category
/newsletter/category
https://rest.messengerpeople.com/api/v14/newsletter/category
Delete a category
Parameter Value Type Description integer The ID 1-10 of a category
Notification Templates new in version 13
-
GET Get
V13/templates/{name}
https://rest.messengerpeople.com/api/v14/templates/{name}
Get a single template
Parameter Value Type Description string The name of the template
-
POST Post
V13/templates
https://rest.messengerpeople.com/api/v14/templates
Create a new template
Parameter Value Type Description string The name of the template
string 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'string WhatsApp Business Account ID
string WhatsApp Business Account Namespace
array An array of the translations
bool In-App visibility of the template
-
PUT Update
V13/templates
https://rest.messengerpeople.com/api/v14/templates
Update a template
Parameter Value Type Description string The id
string The name of the template
string 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'string WhatsApp Business Account ID
string WhatsApp Business Account Namespace
array An array of the translations
bool In-App visibility of the template
-
GET Validate template name
V13/templates/{name}/validate-name
https://rest.messengerpeople.com/api/v14/templates/{name}/validate-name
Check if a template name is not in use
Parameter Value Type Description string The name of the template
-
GET Get template status
V13/templates/{name}/review
https://rest.messengerpeople.com/api/v14/templates/{name}/review
Get a list with review status for each language of a template
Parameter Value Type Description string The name of the template
-
GET Get translation
V13/templates/{name}/translations/{lang}
https://rest.messengerpeople.com/api/v14/templates/{name}/translations/{lang}
Get the translation for a translation of a template
Parameter Value Type Description string The name of the template
string The language of the translation
-
GET Get translation status
V13/templates/{name}/translations/{lang}/review
https://rest.messengerpeople.com/api/v14/templates/{name}/translations/{lang}/review
Get the review status for a single translation of a template
Parameter Value Type Description string The name of the template
string The language of the translation
-
DELETE Delete
V13/templates/{name}
https://rest.messengerpeople.com/api/v14/templates/{name}
Delete a template with all its translations. Note: You can not use the name of the deleted template to create a new one until the deletion is processed by Facebook
Parameter Value Type Description string The name of the template
string The language of the translation
Targeting Lists
-
GET List
/targeting
https://rest.messengerpeople.com/api/v14/targeting
Get information about the available targeting lists
Parameter Value Type Description integer The ID of a single targeting list
boolean(0/1) Status Filter. Use
1
for listing only targeting lists that dont use a status filter and0
for listing targeting lists that filter inactive users. -
PUT Update
/targeting
https://rest.messengerpeople.com/api/v14/targeting
Update an existing targeting list
Parameter Value Type Description integer The targeting id
string The name of the targeting list
json A JSON array of the targeting list configuration
-
POST Create
/targeting
https://rest.messengerpeople.com/api/v14/targeting
Create a new targeting list
Parameter Value Type Description string The name of the targeting
json A JSON array of the targeting list configuration
-
DELETE Delete
/targeting
https://rest.messengerpeople.com/api/v14/targeting
Delete an existing targeting list
Parameter Value Type Description integer The ID of the targeting list
-
GET Configure
/targeting/config
https://rest.messengerpeople.com/api/v14/targeting/config
Get the targeting configuration values
This method has no parameters. -
GET Count
/targeting/count
https://rest.messengerpeople.com/api/v14/targeting/count
Get count of users for a targeting list. To be used with one of the two parameters.
Parameter Value Type Description integer The targeting id
json The targeting query.
Schema:
{"query": {
"condition": "OR",
"rules": [{
"id": "rufnummer",
"field": "rufnummer",
"type": "string",
"input": "text",
"operator": "equal",
"value": "1234"
}]}}
Channel Content
-
GET List
/content
https://rest.messengerpeople.com/api/v14/content
Get information about the available content
Parameter Value Type Description integer The ID of a single content.
string List only drafts if filter = draft, scheduled if filter = scheduled or content that is already published if filter = published.
integer This is the amount of results that is returned.
integer This is the amount of results skipped in the result set.
string Content lists are ordered by published date per default (creation date for drafts).
created
can be specified to order by this attributes.boolean(0/1) Normally content lists are sorted descending which means latest first.
boolean(0/1) 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.boolean(0/1) Specifies whether reach statistics should be additionally split up in 'pulled from' and 'pushed to' for each messenger separately.
-
POST Create
/content
https://rest.messengerpeople.com/api/v14/content
Create a new content
Parameter Value Type Description string The text of the content. Content with audio or document media will ignore the text.
url 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) or document (pdf).
string The original filename of the attachment.
boolean(0/1) If set, store the content as draft, otherwise it will be published.
integer The UNIX timestamp of the publication date in seconds (if not a draft). The current date is used per default.
string 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.
string A special promotion text to be sent in a separate message with the content
string If specified this link is opened directly from notifications in the Notify app. Other messengers will get the text + this weblink.
json Buttons can be attached for all messengers except WhatsApp. A JSON encoded array of buttons can be passed. Each button must define a
caption
(displayed text), atype
(link, postback, call or share) and aninfo
field.- Link must contain a URL.
- Postback a text send back to the server when the user clicks on it
- Call a phone number
- Share a link that can be shared (Facebook only)
Example:[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]
integer Category ID 1-10 or ID of a targeting list.
integer The lifetime of the content after publishing in seconds.
integer The id of the menu item holding the command that is used to pre-fill the users input field in WhatsApp in order to pull the content.
string The name of the WhatsApp notification used for sending
json A JSON array of parameters that are replaced in the WhatsApp notification
string ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter wb_notification is set
string The name of the notification template
json A JSON array of parameters that are replaced in the notification
string 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.string The text to be placed into the header variable
string The suffix added to a dynamic link button
string ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter notification_template is set
-
PUT Update
/content
https://rest.messengerpeople.com/api/v14/content
Update an existing content
Parameter Value Type Description integer The content ID
string The text of the content. Content with audio or document media will ignore the text.
url 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) or document (pdf).
string The original filename of the attachment.
boolean(0/1) If set, store the content as draft, otherwise it will be published.
integer The UNIX timestamp of the publication date in seconds (if not a draft). The current date is used per default.
string A special notification text sent to the Notify app.
string A special promotion text to be sent in a separate message with the content
string If specified this link is opened directly from notifications in the Notify app. Other messengers will get the text + this weblink.
json Buttons can be attached for all messengers except WhatsApp. A JSON encoded array of buttons can be passed. Each button must define a
caption
(displayed text), atype
(link, postback, call or share) and aninfo
field.- Link must contain a URL.
- Postback a text send back to the server when the user clicks on it
- Call a phone number
- Share a link that can be shared (Facebook only)
Example:[ {"type":"link", "caption":"MessengerPeople", "info":"https:\/\/www.messengerpeople.com"}, {"type":"postback", "caption":"Hello","info":"Hello"} ]
integer Category ID 1-10 or ID of a targeting list.
integer The lifetime of the content after publishing in seconds.
integer The id of the menu item holding the command that is used to pre-fill the users input field in WhatsApp in order to pull the content.
string The name of the WhatsApp notification used for sending
json A JSON array of parameters that are replaced in the WhatsApp notification
string ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter wb_notification is set
string The name of the notification template
json A JSON array of parameters that are replaced in the notification
string 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.string The text to be placed into the header variable
string The suffix added to a dynamic link button
string ISO 639-1 Language Code of the notification, that should be send. Defaults to the channel language if no default language for the notification template is set. Mandatory if parameter notification_template is set
-
PUT Stop Interaction
/content/stopinteraction
https://rest.messengerpeople.com/api/v14/content/stopinteraction
Stop the interaction for a content with active interactions
Parameter Value Type Description integer The content ID
-
DELETE Delete
/content
https://rest.messengerpeople.com/api/v14/content
Delete an existing content
Parameter Value Type Description integer The ID of the content.
Statistics
-
GET KPI Rules
/statistics/kpi_rules
https://rest.messengerpeople.com/api/v14/statistics/kpi_rules
Get KPI access control rules defined for the channel
This method has no parameters. -
GET Chat
/statistics/chats
https://rest.messengerpeople.com/api/v14/statistics/chats
Get chat statistics
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Possible values json or csv.
-
GET Tickets
/statistics/tickets
https://rest.messengerpeople.com/api/v14/statistics/tickets
Get ticket statistics
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Possible values json or csv.
-
GET Custom
/statistics/custom
https://rest.messengerpeople.com/api/v14/statistics/custom
Get custom statistics
Parameter Value Type Description int UNIX timestamp of the start of the period, defaults to the last 30 days
int UNIX timestamp of the end of the period, defaults to now
string Return only the given KPI, run without to see all KPIs
string Specify the source of the statistics, expected values: chats, tickets
string Unit of period interval, expected values: hours, days, weeks
string Possible values json or csv.
-
GET Bot
/statistics/bot
https://rest.messengerpeople.com/api/v14/statistics/bot
Get bot statistics
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Possible values json or csv.
-
GET MAU
/statistics/mau
https://rest.messengerpeople.com/api/v14/statistics/mau
Get mau statistics
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Period of invoice, expected values: invoicing_period, last_invoicing_period
If set, this will overrule the parameters 'from' and 'to'bool Group monthly active users by messenger
string Possible values json or csv.
-
GET MAU Details
/statistics/mau_details
https://rest.messengerpeople.com/api/v14/statistics/mau_details
Get detailed mau statistics including user's chat times
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Period of invoice, expected values: invoicing_period, last_invoicing_period
If set, this will overrule the parameters 'from' and 'to'string Possible values json or csv.
-
GET Content
/statistics/content
https://rest.messengerpeople.com/api/v14/statistics/content
Get statistics about the number of reached users starting from 07.12.2019. The numbers are unique users per interval.
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Unit of period interval, expected values: days, weeks, months
string Possible values json or csv.
-
GET Agents
/statistics/agents
https://rest.messengerpeople.com/api/v14/statistics/agents
Get statistics about all agents starting from 01.01.2020.
This feature must be activated by MessengerPeople.
Will return JSON:- "Agent Id"
- "absolute_tickets_closed"
- "absolute_tickets_involved"
- "outgoing_chats_in_ticket"
- "average_time_active_in_ticket"
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Possible values json or csv.
- "Agent Id"
-
GET Notifications
V13/statistics/notifications
https://rest.messengerpeople.com/api/v14/statistics/notifications
Get statistics about all send notifications. Will return JSON:
- template
Name of the notification template - total
Number of notification sent (regardless of the status) - total_sent
Number of notifications sent (without failures) - total_failed
Number of notifications failed sending - total_undelivered
Number of notifications sent, but not jet received by the recipient - total_delivered
Number of notifications sent and received by the recipient - total_read
Number of notifications sent and read by the recipient
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Possible values json or csv.
- template
-
GET Labels
V14/statistics/labels
https://rest.messengerpeople.com/api/v14/statistics/labels
Get statistics about labels assigned to tickets.
If no interval parameter is provided, this will return stats sorted by label in the following JSON structure:{ "example_label": { "stats": { "2020-01-01": 1, "2020-01-02": 3 }, "total": 4 }, ... }
With interval parameter set, this will return stats by interval in the following JSOn structure (note that an interval can have an empty body if no stats where used in this period):{ "1606076985": { <- timestamp "9482": { <- label id "id": 9482, <- label id "label": "example_label", <- label name "color": "FF9300", <- label color HEX value "count": 42 <- usage count for this period }, ... } }
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Unit of period interval, expected values: days, weeks
string Possible values json or csv.
-
GET Automation
/statistics/automation
https://rest.messengerpeople.com/api/v14/statistics/automation
Get statistics about automation effects like chatbot usage and time savings
Parameter Value Type Description integer UNIX timestamp of the start of the period, defaults to the last 30 days
integer UNIX timestamp of the end of the period, defaults to now
string Possible values json or csv.
Statistics (old)
-
GET Current
/stats
https://rest.messengerpeople.com/api/v14/stats
Get current number of users in the channel
This method has no parameters. -
GET Ticket
/stats/ticket
https://rest.messengerpeople.com/api/v14/stats/ticket
Get ticket open / close statistics
This method has no parameters. -
GET Ticket Details
/stats/ticketdetails
https://rest.messengerpeople.com/api/v14/stats/ticketdetails
Get detailed statistics about tickets.
The following statistics data is provided for each time period:- opened: the number of opened tickets
- closed: the number of closed tickets
- average_opened: the average number of open tickets during the whole period
- average_answer_time: the average response time for answers sent
- average_close_time: the average time until a ticket is closed
- average_answers: the average number of answers in closed tickets
Parameter Value Type Description string Specifies the unit of the result. Possible values are hours, days, weeks.
integer UNIX timestamp of the day/hour at which to start the statistics.
Default: Current day for hour statistics, 30 days ago for days or weeksinteger UNIX timestamp at which to end the statistics.
Default: current timestring Possible values json or csv.
-
GET User
/stats/user
https://rest.messengerpeople.com/api/v14/stats/user
Get user statistics of the channel
Parameter Value Type Description boolean(0/1) Specifies whether day statistics should be returned.
Default: 1 unless hour is set.boolean(0/1) Specifies whether hour statistics should be returned.
integer UNIX timestamp of the day/hour at which to start the statistics.
Default: Current day for hour statistics, 30 days ago for daysinteger UNIX timestamp at which to end the statistics.
Default: current timestring Possible values json or csv.
-
GET Newsletter
/stats/newsletter
This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/stats/newsletter
Get newsletter statistics of the channel (since 2021-01-11 newsletters are no longer sent)
Parameter Value Type Description boolean(0/1) Specifies whether day statistics should be returned.
Default: 1 unless hour is set.boolean(0/1) Specifies whether hour statistics should be returned.
integer UNIX timestamp of the day/hour at which to start the statistics.
Default: Current day for hour statistics, 30 days ago for daysinteger UNIX timestamp at which to end the statistics.
Default: current timeboolean(0/1) Specifies whether click statistics should be returned for URLs in the newsletters. Requires enabled click tracking in the channel.
The result shows the total number of clicks and the number of clicks for each messenger. -
GET Chat
/stats/chat
https://rest.messengerpeople.com/api/v14/stats/chat
Get chat statistics of the channel
Parameter Value Type Description boolean(0/1) Specifies whether day statistics should be returned.
Default: 1 unless hour is set.boolean(0/1) Specifies whether hour statistics should be returned.
integer UNIX timestamp of the day/hour at which to start the statistics.
Default: Current day for hour statistics, 30 days ago for daysinteger UNIX timestamp at which to end the statistics.
Default: current timeboolean(0/1) Include bot statistics.
boolean(0/1) Include additional week statistics.
-
GET Bot
/stats/bot
This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/stats/bot
Get bot statistics of the channel
Parameter Value Type Description boolean(0/1) Specifies whether day statistics should be returned.
Default: 1 unless hour is set.boolean(0/1) Specifies whether hour statistics should be returned.
integer UNIX timestamp of the day/hour at which to start the statistics.
Default: Current day for hour statistics, 30 days ago for daysinteger UNIX timestamp at which to end the statistics.
Default: current time -
GET Content
/stats/content
This method has been deprecated and will be removed in future versions. You should avoid using it. https://rest.messengerpeople.com/api/v14/stats/content
Get statistics about number of reached users. The numbers are unique users per unit or during last 30 days. current_push the number of users that will be reached if a content is pushed now. For future usage.
Parameter Value Type Description integer UNIX timestamp of the day/hour at which to start the statistics.
Default: Current day for hour statistics, 30 days ago for daysinteger UNIX timestamp at which to end the statistics.
Default: current timestring The unit of the returned statistics. Possible values are days, weeks or months.
If the unit is omitted, only current_push and last_30days are returned.
Entities
-
GET Entity
/entity/{id}
https://rest.messengerpeople.com/api/v14/entity/{id}
Get ID, name and attributes of entities.
Parameter Value Type Description integer The entity ID.
-
GET Data
/entity/{id}/data/{data_id}
https://rest.messengerpeople.com/api/v14/entity/{id}/data/{data_id}
Get entity data instances
Parameter Value Type Description integer The entity ID
integer The entity data instance ID
-
POST Data
/entity/{id}/data/{data_id}
https://rest.messengerpeople.com/api/v14/entity/{id}/data/{data_id}
Update or create an entity data instance
Parameter Value Type Description integer The entity ID
integer The entity data instance ID, if the id is missing a new instance is created.
json 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": "john.doe@foo.bar" }
-
DELETE Data
/entity/{id}/data/{data_id}
https://rest.messengerpeople.com/api/v14/entity/{id}/data/{data_id}
Delete an entity data instance
Parameter Value Type Description integer The entity ID
integer The entity data instance ID
widget
-
GET Details
/widget
https://rest.messengerpeople.com/api/v14/widget
Get the currently available WhatsApp numbers for customized widgets.
This method has no parameters.
Widget Info
-
GET Widget
/widget_info
https://rest.messengerpeople.com/api/v14/widget_info
Internal widget info
Parameter Value Type Description integer The widget ID. If omitted return old widgets, if 0 return all new widgets, otherwise just the widget with that ID.
-
POST Widget
/widget_info
https://rest.messengerpeople.com/api/v14/widget_info
Create new widget
Parameter Value Type Description string The widget name.
integer The type ID of the widget
string The widget title
string The widget body text
boolean(0/1) Specifies whether a privacy check is displayed.
string The widget privacy text.
string The widget privacy link.
json 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" } ]
json Requires JSON with a list of settings used in the widget. requires id and value
Example:[ { "id": 1, "value": "FFFFAA" }, { "id": 5, "value": 14 } ]
string Wdiget language. Per default the channel language is used.
de
,en
,es
,fr
,it
,nl
,pl
,pt
,ru
,ar
,tr
,hr
andjp
-
PUT Widget
/widget_info/{id}
https://rest.messengerpeople.com/api/v14/widget_info/{id}
Update a widget
Parameter Value Type Description integer The widget ID
string The widget name
integer The type ID of the widget
string The widget title
string The widget body text
boolean(0/1) Specifies whether a privacy check is displayed.
string The widget privacy text
string The widget privacy link
json 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, } ]
json Requires JSON with a list of settings used in the widget. requires id and value
Example:[ { "id": 1, "value": "FFFFAA" }, { "id": 5, "value": 14 } ]
string Wdiget language. Per default the channel language is used.
de
,en
,es
,fr
,it
,nl
,pl
,pt
,ru
,ar
,tr
,hr
andjp
-
DELETE Widget
/widget_info
https://rest.messengerpeople.com/api/v14/widget_info
Delete a widget
Parameter Value Type Description integer The widget ID
-
GET Widget Settings
/widget_info/settings
https://rest.messengerpeople.com/api/v14/widget_info/settings
Internal widget settings
Parameter Value Type Description string Wdiget language. Per default the channel language is used.
de
,en
,es
,fr
,it
,nl
,pl
,pt
,ru
,ar
,tr
,hr
andjp
-
POST Widget Settings
/widget_info/settings
https://rest.messengerpeople.com/api/v14/widget_info/settings
Create new internal widget settings
Parameter Value Type Description string The widget setting name
string The widget settings data type. Possible values are
int
,boolean
,float
,string
,color
. -
PUT Widget Settings
/widget_info/settings/{id}
https://rest.messengerpeople.com/api/v14/widget_info/settings/{id}
Update internal widget settings
Parameter Value Type Description integer The widget settings ID
string The widget settings name
string The widget settings data type. Possible values are
int
,boolean
,float
,string
,color
. -
DELETE Widget Settings
/widget_info/settings/{id}
https://rest.messengerpeople.com/api/v14/widget_info/settings/{id}
Delete internal widget settings
Parameter Value Type Description integer The widget settings ID
ticket
-
GET Details
/ticket/{id}
https://rest.messengerpeople.com/api/v14/ticket/{id}
Get information about a ticket or list all tickets
Parameter Value Type Description mixed 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.
integer This is the amount of results that is returned. If the given amount is 0 the api will fallback to 500. The maximum is 500 if chats of the tickets are listed or 5000 if no chats are listed.
integer This is the amount of results skipped in the result set.
string Field to order the results by. Valid values are 'id', 'closed', 'created', 'status', 'messenger', 'waiting_since', 'label_names', 'agent'.
boolean(0/1) Whether to order the results ascending.
integer The status of the tickets. 0 for closed tickets, 1 for opened tickets
boolean(0/1) List only tickets assigned to me or my team.
mixed The ID of a user or comma-separated list of IDs.
mixed The ID of an agent or comma-separated list of IDs.
mixed The ID of a label or comma-separated list of IDs.
boolean(0/1) List bot chat messages of the ticket.
string 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.
string A filter for listing only tickets of users with this messenger. Valid values are 'WA', 'WB', 'FB', 'TG', 'IN', 'IM', 'VI'. (WA and WB are synonyms)
integer The maximum number of chats that are listed for each ticket .
string 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 .
boolean(0/1) Set to 0 to avoid listing notes of the ticket(s) when ID is not specified.
boolean(0/1) List only new open tickets that have not been answered yet.
boolean(0/1) Include newsletters to tickets chat list.
boolean(0/1) Include custom fields of the user to tickets.
string A filter for listing only closed tickets that are closed within the specified time. Format: from-to, e.g. 0-1552389233 or 1552389233-0 .
boolean(0/1) Include timestamps (last_in/last_out) for last inbound and outbound chat
-
GET Get ticket history
/ticket/{user_id}/ticket_history
https://rest.messengerpeople.com/api/v14/ticket/{user_id}/ticket_history
Get all closed tickets for a given user
Parameter Value Type Description mixed The ID of the user
-
PUT Open
/ticket/{id}/open
https://rest.messengerpeople.com/api/v14/ticket/{id}/open
Get the open ticket for a user or create a new open ticket for the user
Parameter Value Type Description integer The ID of a user.
-
PUT Close
/ticket/{id}/close
https://rest.messengerpeople.com/api/v14/ticket/{id}/close
Close the specified ticket
Parameter Value Type Description integer The ID of a ticket or a user.
string A note added. The agent must be logged in.
mixed Array or comma-separated list of ticket ids. Use instead of the id parameter.
-
PUT Details
/ticket/{id}
https://rest.messengerpeople.com/api/v14/ticket/{id}
Assign an agent or team to a ticket or remove the assignment
Parameter Value Type Description integer The ID of a ticket or a user.
integer The ID of an agent, to sign this ticket to.
integer The ID of a team, to assign this ticket to.
string The email address of an agent, to assign this ticket to. Only works if agent id and team id are not set.
boolean(0/1) Set if you want to activate or deactivate the chatbot for a ticket. Only relevant if the chat for the ticket is locked.
int(1) Mark a ticket as answered even if the user send the last chat by setting waiting_since to 0.
mixed Array or comma-separated list of ticket ids. Use instead of the id parameter.
-
PUT Label
/ticket/{id}/label/{label_id}
https://rest.messengerpeople.com/api/v14/ticket/{id}/label/{label_id}
Assign a label to a ticket.
Since Version 13 you can update the label settings of multiple tickets by using batch_ids and label_ids instead of id and label_id.Parameter Value Type Description integer The ID of a ticket or a user
integer The ID of a label
mixed Array or comma-separated list of ticket ids. Use instead of the id parameter.
mixed Array or comma-separated list of label ids. Use instead of the label_id parameter.
-
DELETE Label
/ticket/{id}/label/{label_id}
https://rest.messengerpeople.com/api/v14/ticket/{id}/label/{label_id}
Delete assignment of a label to a ticket
Parameter Value Type Description integer The ID of a ticket or a user
integer The ID of a label
-
POST Note
/ticket/{id}/note
https://rest.messengerpeople.com/api/v14/ticket/{id}/note
Add a note to a ticket
Parameter Value Type Description integer The ID of a ticket
string The note text
integer Agent ID to use instead of the currently logged-in agent's ID
-
PUT Note
/ticket/{id}/note/{note_id}
https://rest.messengerpeople.com/api/v14/ticket/{id}/note/{note_id}
Update a note of a ticket
Parameter Value Type Description integer The ID of a ticket
integer The ID of a note to update
string The updated note text
-
DELETE Note
/ticket/{id}/note/{note_id}
https://rest.messengerpeople.com/api/v14/ticket/{id}/note/{note_id}
Deletes a note of a ticket
Parameter Value Type Description integer The ID of a ticket
integer The ID of a note to update
-
GET Statistics
/ticket/statistics
https://rest.messengerpeople.com/api/v14/ticket/statistics
Get detailed statistical information on the specified ticket or all tickets created in the specified range and return them in csv format
- TicketID: the ticket number
- Username: the name of the user
- Agent: the name of the current assigned agent
- Created: the creation time of the ticket
- Assigned: the time when the ticket has been assigned to the current agent
- Closed: the time when the ticket has been closed
- Forwarded: the time after which the ticket has been forwarded to a different agent
- Botmessages: the number of bot messages sent while the ticket was opened or before the ticket was opened
- Agentmessages: the number of agent messages sent while the ticket was opened
- DurationChatWithBot: the total number of seconds the user had to wait until he got a response from a bot
- DurationChatWithAgent: the total number of seconds the user had to wait until he got a response from an agent
- TotalAnswerTime: the sum of the answer times both by agent and bot >LI>TotalCloseTime: the number of seconds between ticket creation and ticket close time
- FirstAgentResponseAfter: the number of seconds until the agents first responded to the user
- AverageAgentResponse: the average number of seconds until the agent sent a response to the user considering every answer within the current assigment period.
- FirstAnswerAfter: the number of seconds until the very first response to the user
Parameter | Value | Type | Description |
---|---|---|---|
integer |
ID of a ticket to get statistics from |
||
string |
UNIX timestamp of the day/hour after which tickets have been created. Default last 24 hours |
||
string |
UNIX timestamp of the day/hour before tickets have been created |
||
integer |
This is the amount of results that is returned. |
||
integer |
This is the amount of results skipped in the result set. |
||
boolean[0|1] |
If specified return only one line for each ticket with information about the last assigned agent even if multiple agents had been assigned. |
agent
-
GET Agent Data
/agent/{id}
https://rest.messengerpeople.com/api/v14/agent/{id}
Get information of an agent
Parameter Value Type Description integer The ID of an agent. If omitted list all agents.
-
POST Agent Data
/agent
https://rest.messengerpeople.com/api/v14/agent
Add a new agent
Parameter Value Type Description string The email address of the new agent.
string The role(s) of the agent. All agents must have a role. Multiple roles can be separated by
,
string The first name of the agent. First name and/or last name must be set.
string The last name of the agent. First name and/or last name must be set.
url URL of the profile image of the agent.
boolean(1/0) Set if the agent should receive email notifications when a ticket is assigned or for new chat messages in assigned tickets.
boolean(1/0) Set if the agent has access to all channels.
string One or more channel IDs the agent is assigned to. Will be ignored if all_channels is set.
boolean(1/0) Set if the agent is active and is able to work on tickets.
string A second email address that should receive the email with the login information.
string A user ID registered in one of the account channels that is used for sending the code during 2-factor authentication
-
PUT Agent Data
/agent/{id}
https://rest.messengerpeople.com/api/v14/agent/{id}
Update profile information of an agent
Parameter Value Type Description integer The ID of an agent.
string The role(s) of the agent. All agents must have a role. Multiple roles can be separated by
,
string The first name of the agent. First name and/or last name must be set.
string The last name of the agent. First name and/or last name must be set.
url URL of the profile image of the agent.
boolean(1/0) Set if the agent should receive email notifications when a ticket is assigned, for new chat messages in assigned tickets or unassigned tickets for dispatcher.
integer Delay between email notifications in minutes
boolean(1/0) Set if the agent is active and is able to work on tickets.
boolean(1/0) Set if the agent has access to all channels.
string One or more channel IDs the agent is assigned to. Will be ignored if all_channels is set.
string Agent frontend language. Possible values:
en
,de
,es
,fr
,ar
,it
json Requires JSON with any name => value pairs. Example:
{ "setting": "value" }
Delete a setting by setting the value as empty string.
json A JSON array of skill IDs to assign to this agent
string A user ID registered in one of the account channels that is used for sending the code during 2-factor authentication
-
PUT Agent Status
/agent/status
https://rest.messengerpeople.com/api/v14/agent/status
Set the status of the logged in agent
Parameter Value Type Description integer Set the current online status for this agent.
0
= offline1
= online (green)2
= away / inactive (yellow)3
= busy (red)
-
GET Temporary Token
/agent/temporary/token
https://rest.messengerpeople.com/api/v14/agent/temporary/token
Get a temporary token for logging in with a second device. The token is valid for 10 minutes. The method is only usable by logged in agents.
Parameter Value Type Description string The device id of the primary device
-
PUT Agent Password
/agent/password
https://rest.messengerpeople.com/api/v14/agent/password
Change the password of the logged in agent
Parameter Value Type Description password The old password of the agent
password The new password of the agent
-
DELETE Agent
/agent/{id}
https://rest.messengerpeople.com/api/v14/agent/{id}
Delete an agent. The owner of a customer account cannot be deleted.
Parameter Value Type Description integer The ID of an agent
bot
-
GET bot
/bot/content/targeting
https://rest.messengerpeople.com/api/v14/bot/content/targeting
Parameter Value Type Description array -
GET bot
/bot/recommendations
https://rest.messengerpeople.com/api/v14/bot/recommendations
This method has no parameters. -
PUT Bot Status
/bot
https://rest.messengerpeople.com/api/v14/bot
Update the bot status
Parameter Value Type Description boolean(0/1) Set active (
1
) or inactive (0
). -
GET Bot Status
/bot
https://rest.messengerpeople.com/api/v14/bot
Get information about the bot status
This method has no parameters. -
GET Chats
/bot/chat
https://rest.messengerpeople.com/api/v14/bot/chat
Get all or specific bot chats
Parameter Value Type Description integer The ID of a chat.
-
GET Manual Answer
/bot/manualanswer
https://rest.messengerpeople.com/api/v14/bot/manualanswer
Get bot answers to be sent manually
Parameter Value Type Description integer The ID of a bot message sent manually.
string List only bot chats with a specific release status
The following values are available: DRAFT, RELEASED, PERSONAL, REJECTED