Comment on page
Messaging Channels
Send messages to your customers using different communication channels.
To support Messaging Channels for Identities you must enable Infobip CDP Extension. Messging Channel for Users are supported by default.
Messeges to Users are always sent from Orangepill, while messages to Persons are sent from your Infobip account.
Use /v1/users/{id}/message/sms APi call to send SMS message. Message is sent to phone number set in
channel.sms
field of User object.cURL
curl --location --request POST 'https://api.orangepill.cloud/v1/users/634b56217f6a7b0be52dffbd/message/sms' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'idempotency-key: 27373fabc392933deffda' \
--header 'Content-Type: application/json' \
--data-raw '{
"content": {
"text": "This is test SMS message"
}
}'
in response you will get message processing status.
Response
{
"messages": [
{
"messageId": "3919977727444335893722",
"status": {
"groupId": 1,
"groupName": "PENDING",
"id": 26,
"name": "PENDING_ACCEPTED",
"description": "Message sent to next instance"
},
"destination": "38598123456"
}
]
}
You cannot send WhatsApp message to User unless User has interacted with Orangepill bot on WhatsApp number 447860088593.
Use /v1/users/{id}/message/whatsapp APi call to send SMS message. Message is sent to phone number set in
channel.whatsapp
field of User object.cURL
curl --location --request POST 'https://api.orangepill.cloud/v1/users/634b56217f6a7b0be52dffbd/message/whatsapp' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'idempotency-key: 27373fabc392933deffda' \
--header 'Content-Type: application/json' \
--data-raw '{
"content": {
"text": "This is test WhatsApp message"
}
}'
in response you will get message processing status.
Response
{
"messages": [
{
"messageId": "3919977727444335893722",
"status": {
"groupId": 1,
"groupName": "PENDING",
"id": 26,
"name": "PENDING_ACCEPTED",
"description": "Message sent to next instance"
},
"destination": "38598123456"
}
]
}
Use /v1/users/{id}/message/email APi call to send SMS message. Message is sent to phone number set in
channel.email
field of User object.You can send email messages in text ot html body format. If both parameters are set, message is sent in html format.
cURL
curl --location --request POST 'https://api.orangepill.cloud/v1/users/634b56217f6a7b0be52dffbd/message/email' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'idempotency-key: 27373fabc392933deffda' \
--header 'Content-Type: application/json' \
--data-raw '{
"content": {
"subject": "This is a test subject",
"html": "<b>This is test html email message</b>",
"text": "This is test text email message"
}
}'
in response you will get message processing status.
Response
{
"messages": [
{
"messageId": "3919977727444335893722",
"status": {
"groupId": 1,
"groupName": "PENDING",
"id": 26,
"name": "PENDING_ACCEPTED",
"description": "Message sent to next instance"
},
"destination": "38598123456"
}
]
}
To be able to send SMS, WhatsApp and Email messages to Persons channel must be configured in your Infobip account.
Use /v1/identities/{id}/person/message/sms APi call to send SMS message. Message is sent to phone number set in
person.contactInformation.phone[0].number
field of Identity object.cURL
curl --location --request POST 'https://api.orangepill.cloud/v1/identities/634b56217f6a7b0be52dffbd/person/message/sms' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'idempotency-key: 27373fabc392933deffda' \
--header 'Content-Type: application/json' \
--data-raw '{
"content": {
"text": "This is test SMS message"
}
}'
in response you will get message processing status.
Response
{
"messages": [
{
"messageId": "3919977727444335893722",
"status": {
"groupId": 1,
"groupName": "PENDING",
"id": 26,
"name": "PENDING_ACCEPTED",
"description": "Message sent to next instance"
},
"destination": "38598123456"
}
]
}
You cannot send WhatsApp message to User unless User has interacted with WhatsApp number configured in your Infobip account..
Use /v1/identities/{id}/person/message/whatsapp APi call to send SMS message. Message is sent to phone number set in
person.contactInformation.phone[0].number
field of Identity object.cURL
curl --location --request POST 'https://api.orangepill.cloud/v1/identities/634b56217f6a7b0be52dffbd/person/message/whatsapp' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'idempotency-key: 27373fabc392933deffda' \
--header 'Content-Type: application/json' \
--data-raw '{
"content": {
"text": "This is test SMS message"
}
}'
in response you will get message processing status.
Response
{
"messages": [
{
"messageId": "3919977727444335893722",
"status": {
"groupId": 1,
"groupName": "PENDING",
"id": 26,
"name": "PENDING_ACCEPTED",
"description": "Message sent to next instance"
},
"destination": "38598123456"
}
]
}
Use /v1/identities/{id}/person/message/email APi call to send SMS message. Message is sent to phone number set in
person.contactInformation.email[0].address
field of Identity object.You can send email messages in text ot html body format. If both parameters are set, message is sent in html format.
cURL
curl --location --request POST 'https://api.orangepill.cloud/v1/identities/634b56217f6a7b0be52dffbd/person/message/sms' \
--header 'x-api-key: AXVubzpwQDU1dzByYM==' \
--header 'idempotency-key: 27373fabc392933deffda' \
--header 'Content-Type: application/json' \
--data-raw '{
"content": {
"subject": "This is a test subject",
"html": "<b>This is test html email message</b>",
"text": "This is test text email message"
}
}'
in response you will get message processing status.
Response
{
"messages": [
{
"messageId": "3919977727444335893722",
"status": {
"groupId": 1,
"groupName": "PENDING",
"id": 26,
"name": "PENDING_ACCEPTED",
"description": "Message sent to next instance"
},
"destination": "38598123456"
}
]
}
Last modified 3mo ago