Skip to content

Infobip

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

NameLabelTypeDescriptionRequired
keyAPI KeySTRINGtrue
baseUrlBase URLSTRINGPersonalized base URL for API requests.true

Actions

Send SMS

Name: sendSMS

Send a new SMS message

Properties

NameLabelTypeDescriptionRequired
senderFromSTRINGThe sender ID. It can be alphanumeric or numeric (e.g., CompanyName).true
toToARRAY
Items [STRING]
Message recipient numbers.true
textTextSTRINGContent 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

NameTypeDescription
bulkIdSTRINGID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
messagesARRAY
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 Text Message

Name: sendWhatsappTextMessage

Send a new SMS message

Properties

NameLabelTypeDescriptionRequired
fromFromSTRINGRegistered WhatsApp sender number. Must be in international format and comply with WhatsApp’s requirements.true
toToSTRINGMessage recipient number. Must be in international format.true
textTextSTRINGContent 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

NameTypeDescription
toSTRINGThe destination address of the message.
messageCountINTEGERNumber of messages required to deliver.
messageIdSTRINGID of the message sent.
statusOBJECT
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

NameLabelTypeDescriptionRequired
numberKeyNumberSTRINGtrue

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" : {
"numberKey" : ""
},
"type" : "infobip/v1/newSMS"
}

New WhatsApp Message

Name: newWhatsappMessage

Triggers when a new WhatsApp message is received.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeDescriptionRequired
numberKeyNumberSTRINGtrue

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" : {
"numberKey" : ""
},
"type" : "infobip/v1/newWhatsappMessage"
}


Additional instructions


CONNECTION