ByteChefInfobip
Infobip is a global communications platform that provide cloud-based messaging and omnichannel communication solutions for businesses.
Categories: Communication
Type: infobip/v1
Connections
Version: 1
API Key
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| key | API Key | STRING | true | |
| baseUrl | Base URL | STRING | Personalized base URL for API requests. | true |
Actions
Send SMS
Name: sendSMS
Send a new SMS message
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| sender | From | STRING | The sender ID. It can be alphanumeric or numeric (e.g., CompanyName). | true |
| to | To | ARRAY Items[STRING] | Message recipient numbers. | true |
| text | Text | STRING | Content of the message being sent. | true |
Example JSON Structure
{
"label" : "Send SMS",
"name" : "sendSMS",
"parameters" : {
"sender" : "",
"to" : [ "" ],
"text" : ""
},
"type" : "infobip/v1/sendSMS"
}Output
Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| bulkId | STRING | ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. |
| messages | ARRAY Items[{STRING(messageId), {INTEGER(groupId), STRING(groupName), INTEGER(id), STRING(name), STRING(description), STRING(action)}(status), STRING(destination), {INTEGER(messageCount)}(details)}] | An array of message objects of a single message or multiple messages sent under one bulk ID. |
Output Example
{
"bulkId" : "",
"messages" : [ {
"messageId" : "",
"status" : {
"groupId" : 1,
"groupName" : "",
"id" : 1,
"name" : "",
"description" : "",
"action" : ""
},
"destination" : "",
"details" : {
"messageCount" : 1
}
} ]
}Send Whatsapp Template Message
Name: sendWhatsappTemplateMessage
Send a template message.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| from | From | STRING | Registered WhatsApp sender number. Must be in international format and comply with WhatsApp's requirements. | true |
| to | To | STRING | Message recipient number. Must be in international format. | true |
| templateName | Template Name | STRING Depends Onfrom | Name of the WhatsApp template to use. | true |
| placeholders | DYNAMIC_PROPERTIES Depends OntemplateName | null |
Example JSON Structure
{
"label" : "Send Whatsapp Template Message",
"name" : "sendWhatsappTemplateMessage",
"parameters" : {
"from" : "",
"to" : "",
"templateName" : "",
"placeholders" : { }
},
"type" : "infobip/v1/sendWhatsappTemplateMessage"
}Output
Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| messages | ARRAY Items[{STRING(to), INTEGER(messageCount), STRING(messageId), {INTEGER(groupId), STRING(groupName), INTEGER(id), STRING(name), STRING(description), STRING(action)}(status)}] |
Output Example
{
"messages" : [ {
"to" : "",
"messageCount" : 1,
"messageId" : "",
"status" : {
"groupId" : 1,
"groupName" : "",
"id" : 1,
"name" : "",
"description" : "",
"action" : ""
}
} ]
}Send WhatsApp Text Message
Name: sendWhatsappTextMessage
Send a WhatsApp text message to a single recipient.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| from | From | STRING | Registered WhatsApp sender number. Must be in international format and comply with WhatsApp's requirements. | true |
| to | To | STRING | Message recipient number. Must be in international format. | true |
| text | Text | STRING | Content of the message being sent. | true |
Example JSON Structure
{
"label" : "Send WhatsApp Text Message",
"name" : "sendWhatsappTextMessage",
"parameters" : {
"from" : "",
"to" : "",
"text" : ""
},
"type" : "infobip/v1/sendWhatsappTextMessage"
}Output
Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| to | STRING | The destination address of the message. |
| messageCount | INTEGER | Number of messages required to deliver. |
| messageId | STRING | ID of the message sent. |
| status | OBJECT Properties{INTEGER(groupId), STRING(groupName), INTEGER(id), STRING(name), STRING(description), STRING(action)} | Status of the message. |
Output Example
{
"to" : "",
"messageCount" : 1,
"messageId" : "",
"status" : {
"groupId" : 1,
"groupName" : "",
"id" : 1,
"name" : "",
"description" : "",
"action" : ""
}
}Triggers
New SMS Message
Name: newSMS
Triggers when a new SMS message is received.
Type: DYNAMIC_WEBHOOK
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| number | Number | STRING | true |
Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
JSON Example
{
"label" : "New SMS Message",
"name" : "newSMS",
"parameters" : {
"number" : ""
},
"type" : "infobip/v1/newSMS"
}New WhatsApp Message
Name: newWhatsappMessage
Triggers when a new WhatsApp message is received.
Type: DYNAMIC_WEBHOOK
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| number | Number | STRING | true | |
| keyword | Keyword | STRING | null |
Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
JSON Example
{
"label" : "New WhatsApp Message",
"name" : "newWhatsappMessage",
"parameters" : {
"number" : "",
"keyword" : ""
},
"type" : "infobip/v1/newWhatsappMessage"
}What to do if your action is not listed here?
If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.