With Bird modules in Boost.space Integrator, you can manage the SMS, contacts, and groups in your Bird account.
To use the Bird modules, you must have a Bird account. You can create an account at bird.com.
Refer to the Bird API documentation for a list of available endpoints.
To establish the connection, you must:
To obtain your API key from your Bird account:
To establish the connection in Boost.space Integrator:
-
Log in to your Boost.space Integrator account, add a Bird module to your scenario, and click Create a connection.
-
Optional: In the Connection name field, enter a name for the connection.
-
In the Access Key field, enter the API key copied above.
-
Click Save.
-
If prompted, authenticate your account and confirm access.
You have successfully established the connection. You can now edit your scenario and add more Bird modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.
After connecting the app, you can perform the following actions:
Deletes an SMS message.
|
Connection |
|
|
Message ID |
Enter the Message ID you want to delete. |
Gets details of an SMS message.
|
Connection |
|
|
Message ID |
Enter the Message ID you want to read. |
Retrieves a list of SMS messages that were sent or received.
|
Connection |
|
|
Limit |
Enter the number of messages Boost.space Integrator should return during one execution cycle. |
|
Originator |
Enter the sender number whose messages you want to list. |
|
Recipient |
Enter the recipient number whose messages you want to list. |
|
Direction |
Select the message direction:
|
|
Type |
Select the message type:
|
|
Status |
Select the status of the messages you want to list:
|
Sends an SMS message via Bird.
|
Connection |
|
|
Recipients |
Enter the recipient number to whom you want to send the message. |
|
Originator |
Enter the sender details. You can either enter the sender’s phone number with country code or name or text that is alphanumeric. |
|
Body |
Enter the message text. |
|
Reference |
Enter the client reference number of the message. |
|
Report URL |
Enter the message status report URL. |
Triggers when a new SMS message is sent or received.
|
Connection |
|
|
Limit |
Enter the maximum number of messages Boost.space Integrator should return during one execution cycle. |
|
Originator |
Enter the sender number whose messages you want to watch. |
|
Recipient |
Enter the recipient number whose messages you want to watch. |
|
Direction |
Select the message direction:
|
|
Type |
Select the message type:
|
|
Status |
Select the status of the messages you want to watch:
|
Creates a contact.
|
Connection |
|
|
Phone Number |
Enter the phone number of the contact. |
|
First Name |
Enter the first name of the contact. |
|
Last Name |
Enter the last name of the contact. |
|
Custom Field 1 – 4 |
Add custom fields for the contact. |
Retrieves the information of an existing contact.
|
Connection |
|
|
Contact ID |
Enter the Contact ID whose details you want to retrieve. |
Adds a contact to a group.
|
Connection |
|
|
Group ID |
Enter the Group ID to which you want to add to the contacts. |
|
IDs |
Add the Contact IDs of the contact. You can add a maximum of 50 contacts. |
Removes a contact from a group.
|
Connection |
|
|
Group ID |
Enter the Group ID from which you want to remove the contact. |
|
Contact ID |
Enter the Contact ID you want to remove from the group. |
Deletes a contact.
|
Connection |
|
|
Contact ID |
Enter the Contact ID you want to delete. |
Updates the contact.
|
Connection |
|
|
Contact ID |
Enter the Contact ID you want to update. |
|
Phone Number |
Enter the phone number of the contact |
|
First Name |
Enter the first name of the contact. |
|
Last Name |
Enter the last name of the contact. |
|
Custom Field 1 – 4 |
Add custom fields for the contact. |
Creates a group.
|
Connection |
|
|
Name |
Enter the name of the group. |
Deletes a group.
|
Connection |
|
|
Group ID |
Enter the Group ID you want to delete. |