Connectors Reference
Provide SMS and VOICE communication channels for enterprises over Infobip platform to better their customer engagement.
|
Status: Preview |
Tier: Premium |
Version: 1.1 |
|
Name |
Summary |
|
Stop incoming text message trigger |
|
|
Send a text message (SMS) |
|
|
MakeInfobipVoiceCall ([Optional]VoiceCallRequestBody Request body) |
Make a voice call |
|
Check current balance |
|
Name |
Summary |
|
When you receive an incoming text message |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Stop incoming text message trigger
Description: This action will stop the trigger for incoming text messages that you previously registered.
Syntax:
Infobip.RemoveInfobipSMSWebhook (string webhook_key)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webhook_key |
string
|
Key of the webhook to remove. |
True |
Returns:
Summary: Send a text message (SMS)
Description: This action will send an outbound text message (SMS).
Syntax:
Infobip.SendInfobipSMS ([Optional]SendSMSRequestBody Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
|
|
False |
Returns:
Type:SendSMSSuccessResponseBody
Summary: Make a voice call
Description: This action will make an outbound voice call and read your message using text to speech synthesis.
Syntax:
Infobip.MakeInfobipVoiceCall ([Optional]VoiceCallRequestBody Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body |
|
|
False |
Returns:
Type:VoiceCallSuccessResponseBody
Summary: Check current balance
Description: This action will return you the current balance of your account.
Syntax:
Infobip.CheckCurrentBalance ()
Returns:
Type:BalanceSuccessResponseBody
Summary: When you receive an incoming text message
Description: This operation triggers when you receive an incoming text message (SMS) on the number you bought from Infobip.
Syntax:
Infobip.CreateInfobipSMSWebhook (CreateInfobipSMSWebhookParameterRequest body of webhook Request body of webhook)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Request body of webhook |
CreateInfobipSMSWebhookParameterRequest body of webhook
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
balance |
number Current account balance |
Current account balance, expressed in the specified currency. |
|
currency |
string Currency used to express the balance in |
Currency used to express the balance in. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
phoneNumber |
string
|
Phone number that you have purchased through Infobip platform. |
|
keyword |
string
|
Unique keyword used for this Flow. |
|
webhookUrl |
string
|
Url that SMS messages will be pushed to. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
from |
string Sender's phone number |
Phone number that will be used as a sender of the outbound text message. |
|
to |
string Recipient's phone number |
Phone number that the text message will be sent to. |
|
text |
string Message |
Text of the message that will be sent. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
messages |
array of (MessagesItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
to |
string Destination phone number |
Cleaned up and standardized phone number that the text message was sent to. |
|
messageId |
string Unique message id |
Id that uniquely identifies sent text message, can later be used to fetch message log. |
|
status |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
number Message sending status id |
Id of the status of message sending. |
|
name |
string Message sending status |
Name of the status of message sending. |
|
description |
string Description of message sending status |
Human readable description of the status of message sending. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
from |
string Caller's phone number |
Phone number that will be used as a caller of the outbound voice call. |
|
to |
string Recipient's phone number |
Phone number that voice call will be made to. |
|
text |
string Message |
Text of the message that will be read out loud in the call. |
|
language |
string Language |
Language of the call's message. Values: [en, es, ca, zh-cn, zh-tw, da, nl, fr, de, it, ja, ko, no, pl, pt-pt, pt-br, ru, sv, fi, tr] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
messages |
array of (MessagesItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
to |
string Destination phone number |
Cleaned up and standardized phone number that the voice call was made to. |
|
messageId |
string Unique message id |
Id that uniquely identifies made voice call, can later be used to fetch message log. |
|
status |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
number Message sending status id |
Id of the status of the call. |
|
name |
string Message sending status |
Name of the status of the call. |
|
description |
string Description of message sending status |
Human readable description of the status of the call. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
|
|
id |
integer
|
|
|
name |
string
|
|
|
active |
boolean
|
|
|
events |
array of (string)
|
|
|
config |
|
|
|
updated_at |
string
|
|
|
created_at |
string
|
|
|
url |
string
|
|
|
test_url |
string
|
|
|
ping_url |
string
|
|
|
last_response |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
content_type |
string
|
|
|
url |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
|
|
status |
string
|
|
|
message |
string
|
|