Connectors Reference

Infobip

Enable enterprise grade communication over Infobip.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

RemoveInfobipSMSWebhook ([internal]string User-Agent, string webhook_key)

Stop incoming text message trigger

SendInfobipSMS ([internal]string User-Agent, [Optional]SendSMSRequestBody Request body)

Send a text message (SMS)

MakeInfobipVoiceCall ([internal]string User-Agent, [Optional]VoiceCallRequestBody Request body)

Make a voice call

CheckCurrentBalance ([internal]string User-Agent)

Check current balance

 

Triggers:

Name

Summary

CreateInfobipSMSWebhook ([internal]string User-Agent, [Optional]WebhookRequestBody Request body of webhook)

When you receive an incoming text message

 

Objects:

Name

Summary

BalanceSuccessResponseBody

 

SendSMSRequestBody

 

SendSMSSuccessResponseBody

 

VoiceCallRequestBody

 

VoiceCallSuccessResponseBody

 

WebhookCreationResponse

 

WebhookRequestBody

 

 

Actions:

RemoveInfobipSMSWebhook

Summary: Stop incoming text message trigger

Description: This action will stop the trigger for incoming text messages that you previously registered.

 

Syntax:

Infobip.RemoveInfobipSMSWebhook ([internal]string User-Agent, string webhook_key)

 

Parameters:

Name

Type

Summary

Required

Related Action

User-Agent

string

 

Mandatory header for identifying API integrations.

True

webhook_key

string

 

Key of the webhook to remove.

True

 

Returns:

 

SendInfobipSMS

Summary: Send a text message (SMS)

Description: This action will send an outbound text message (SMS).

 

Syntax:

Infobip.SendInfobipSMS ([internal]string User-Agent, [Optional]SendSMSRequestBody Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

User-Agent

string

(User-Agent header)

Mandatory header for identifying API integrations.

True

Request body

SendSMSRequestBody

 

 

False

 

Returns:

          Type:SendSMSSuccessResponseBody

 

MakeInfobipVoiceCall

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 ([internal]string User-Agent, [Optional]VoiceCallRequestBody Request body)

 

Parameters:

Name

Type

Summary

Required

Related Action

User-Agent

string

(User-Agent header)

Mandatory header for identifying API integrations.

True

Request body

VoiceCallRequestBody

 

 

False

 

Returns:

          Type:VoiceCallSuccessResponseBody

 

CheckCurrentBalance

Summary: Check current balance

Description: This action will return you the current balance of your account.

 

Syntax:

Infobip.CheckCurrentBalance ([internal]string User-Agent)

 

Parameters:

Name

Type

Summary

Required

Related Action

User-Agent

string

(User-Agent header)

Mandatory header for identifying API integrations.

True

 

Returns:

          Type:BalanceSuccessResponseBody

 

Triggers:

Trigger CreateInfobipSMSWebhook

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 ([internal]string User-Agent, [Optional]WebhookRequestBody Request body of webhook)

 

Parameters:

Name

Type

Summary

Required

Related Action

User-Agent

string

 

Mandatory header for identifying API integrations.

True

Request body of webhook

WebhookRequestBody

 

 

False

 

Returns:

          Type:WebhookCreationResponse

 


 

BalanceSuccessResponseBody

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.


 

SendSMSRequestBody

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.


 

SendSMSSuccessResponseBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

messages

array of (MessagesItem)

 

 

 

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

Status

 

 

 

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.

 


 

VoiceCallRequestBody

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]


 

VoiceCallSuccessResponseBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

messages

array of (MessagesItem)

 

 

 

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

Status

 

 

 

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.

 


 

WebhookCreationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

 

id

integer

 

 

name

string

 

 

active

boolean

 

 

events

array of (string)

 

 

config

Config

 

 

updated_at

string

 

 

created_at

string

 

 

url

string

 

 

test_url

string

 

 

ping_url

string

 

 

last_response

Last_response

 

 

 

Config

Summary:

Description:

 

          Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 

Last_response

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

 

 

status

string

 

 

message

string

 

 

 


 

WebhookRequestBody

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.