productivity
MessageBird CLI for AI Agents
Use the MessageBird CLI from KosmoKrator to call MessageBird tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.MessageBird CLI Setup
MessageBird can be configured headlessly with `kosmokrator integrations:configure messagebird`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure messagebird --set api_key="$MESSAGEBIRD_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor messagebird --json
kosmokrator integrations:status --json Credentials
Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
api_key | MESSAGEBIRD_API_KEY | Secret secret | yes | API Key |
url | MESSAGEBIRD_URL | URL url | no | API Base URL |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call messagebird.messagebird_send_sms '{"originator":"example_originator","recipients":"example_recipients","body":"example_body","options":"example_options"}' --json kosmo integrations:messagebird messagebird_send_sms '{"originator":"example_originator","recipients":"example_recipients","body":"example_body","options":"example_options"}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs messagebird --json
kosmo integrations:docs messagebird.messagebird_send_sms --json
kosmo integrations:schema messagebird.messagebird_send_sms --json
kosmo integrations:search "MessageBird" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
messagebird.messagebird_send_sms
Send an SMS message to one or more recipients via MessageBird. Specify a sender (originator), one or more phone numbers, and the message body.
write - Parameters
- originator, recipients, body, options
kosmo integrations:call messagebird.messagebird_send_sms '{"originator":"example_originator","recipients":"example_recipients","body":"example_body","options":"example_options"}' --json kosmo integrations:messagebird messagebird_send_sms '{"originator":"example_originator","recipients":"example_recipients","body":"example_body","options":"example_options"}' --json messagebird.messagebird_list_messages
List sent and received messages from MessageBird. Supports filtering by status and direction, with pagination.
read - Parameters
- limit, offset, status, direction, originator, recipient, contact_id
kosmo integrations:call messagebird.messagebird_list_messages '{"limit":1,"offset":1,"status":"example_status","direction":"example_direction","originator":"example_originator","recipient":"example_recipient","contact_id":"example_contact_id"}' --json kosmo integrations:messagebird messagebird_list_messages '{"limit":1,"offset":1,"status":"example_status","direction":"example_direction","originator":"example_originator","recipient":"example_recipient","contact_id":"example_contact_id"}' --json messagebird.messagebird_get_message
Retrieve details of a specific MessageBird message by its ID, including status, recipient info, and delivery timestamps.
read - Parameters
- id
kosmo integrations:call messagebird.messagebird_get_message '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_get_message '{"id":"example_id"}' --json messagebird.messagebird_delete_message
Delete a scheduled MessageBird SMS message.
write - Parameters
- id
kosmo integrations:call messagebird.messagebird_delete_message '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_delete_message '{"id":"example_id"}' --json messagebird.messagebird_send_voice_message
Send a MessageBird text-to-speech voice message.
write - Parameters
- originator, recipients, body, options
kosmo integrations:call messagebird.messagebird_send_voice_message '{"originator":"example_originator","recipients":"example_recipients","body":"example_body","options":"example_options"}' --json kosmo integrations:messagebird messagebird_send_voice_message '{"originator":"example_originator","recipients":"example_recipients","body":"example_body","options":"example_options"}' --json messagebird.messagebird_list_voice_messages
List MessageBird voice messages with optional filters.
read - Parameters
- limit, offset, originator, recipient, status, contact_id
kosmo integrations:call messagebird.messagebird_list_voice_messages '{"limit":1,"offset":1,"originator":"example_originator","recipient":"example_recipient","status":"example_status","contact_id":"example_contact_id"}' --json kosmo integrations:messagebird messagebird_list_voice_messages '{"limit":1,"offset":1,"originator":"example_originator","recipient":"example_recipient","status":"example_status","contact_id":"example_contact_id"}' --json messagebird.messagebird_get_voice_message
Get a MessageBird voice message by ID.
read - Parameters
- id
kosmo integrations:call messagebird.messagebird_get_voice_message '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_get_voice_message '{"id":"example_id"}' --json messagebird.messagebird_delete_voice_message
Delete a scheduled MessageBird voice message.
write - Parameters
- id
kosmo integrations:call messagebird.messagebird_delete_voice_message '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_delete_voice_message '{"id":"example_id"}' --json messagebird.messagebird_list_contacts
List MessageBird contacts.
read - Parameters
- limit, offset
kosmo integrations:call messagebird.messagebird_list_contacts '{"limit":1,"offset":1}' --json kosmo integrations:messagebird messagebird_list_contacts '{"limit":1,"offset":1}' --json messagebird.messagebird_create_contact
Create a MessageBird contact.
write - Parameters
- contact
kosmo integrations:call messagebird.messagebird_create_contact '{"contact":"example_contact"}' --json kosmo integrations:messagebird messagebird_create_contact '{"contact":"example_contact"}' --json messagebird.messagebird_get_contact
Get a MessageBird contact by ID.
read - Parameters
- id
kosmo integrations:call messagebird.messagebird_get_contact '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_get_contact '{"id":"example_id"}' --json messagebird.messagebird_update_contact
Update a MessageBird contact.
write - Parameters
- id, contact
kosmo integrations:call messagebird.messagebird_update_contact '{"id":"example_id","contact":"example_contact"}' --json kosmo integrations:messagebird messagebird_update_contact '{"id":"example_id","contact":"example_contact"}' --json messagebird.messagebird_delete_contact
Delete a MessageBird contact.
write - Parameters
- id
kosmo integrations:call messagebird.messagebird_delete_contact '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_delete_contact '{"id":"example_id"}' --json messagebird.messagebird_list_contact_groups
List groups for a MessageBird contact.
read - Parameters
- id
kosmo integrations:call messagebird.messagebird_list_contact_groups '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_list_contact_groups '{"id":"example_id"}' --json messagebird.messagebird_list_contact_messages
List MessageBird messages for a contact.
read - Parameters
- id, params
kosmo integrations:call messagebird.messagebird_list_contact_messages '{"id":"example_id","params":"example_params"}' --json kosmo integrations:messagebird messagebird_list_contact_messages '{"id":"example_id","params":"example_params"}' --json messagebird.messagebird_list_groups
List MessageBird contact groups.
read - Parameters
- limit, offset
kosmo integrations:call messagebird.messagebird_list_groups '{"limit":1,"offset":1}' --json kosmo integrations:messagebird messagebird_list_groups '{"limit":1,"offset":1}' --json messagebird.messagebird_create_group
Create a MessageBird contact group.
write - Parameters
- name
kosmo integrations:call messagebird.messagebird_create_group '{"name":"example_name"}' --json kosmo integrations:messagebird messagebird_create_group '{"name":"example_name"}' --json messagebird.messagebird_get_group
Get a MessageBird contact group.
read - Parameters
- id
kosmo integrations:call messagebird.messagebird_get_group '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_get_group '{"id":"example_id"}' --json messagebird.messagebird_update_group
Update a MessageBird contact group.
write - Parameters
- id, name
kosmo integrations:call messagebird.messagebird_update_group '{"id":"example_id","name":"example_name"}' --json kosmo integrations:messagebird messagebird_update_group '{"id":"example_id","name":"example_name"}' --json messagebird.messagebird_delete_group
Delete a MessageBird contact group.
write - Parameters
- id
kosmo integrations:call messagebird.messagebird_delete_group '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_delete_group '{"id":"example_id"}' --json messagebird.messagebird_list_group_contacts
List contacts in a MessageBird group.
read - Parameters
- id, params
kosmo integrations:call messagebird.messagebird_list_group_contacts '{"id":"example_id","params":"example_params"}' --json kosmo integrations:messagebird messagebird_list_group_contacts '{"id":"example_id","params":"example_params"}' --json messagebird.messagebird_add_contact_to_group
Add a contact to a MessageBird group.
write - Parameters
- group_id, contact_id
kosmo integrations:call messagebird.messagebird_add_contact_to_group '{"group_id":"example_group_id","contact_id":"example_contact_id"}' --json kosmo integrations:messagebird messagebird_add_contact_to_group '{"group_id":"example_group_id","contact_id":"example_contact_id"}' --json messagebird.messagebird_remove_contact_from_group
Remove a contact from a MessageBird group.
write - Parameters
- group_id, contact_id
kosmo integrations:call messagebird.messagebird_remove_contact_from_group '{"group_id":"example_group_id","contact_id":"example_contact_id"}' --json kosmo integrations:messagebird messagebird_remove_contact_from_group '{"group_id":"example_group_id","contact_id":"example_contact_id"}' --json messagebird.messagebird_lookup_phone_number
Validate and look up a phone number with MessageBird Lookup.
read - Parameters
- phone_number, country_code
kosmo integrations:call messagebird.messagebird_lookup_phone_number '{"phone_number":"example_phone_number","country_code":"example_country_code"}' --json kosmo integrations:messagebird messagebird_lookup_phone_number '{"phone_number":"example_phone_number","country_code":"example_country_code"}' --json messagebird.messagebird_get_hlr_lookup
Get MessageBird HLR lookup information for a phone number.
read - Parameters
- phone_number
kosmo integrations:call messagebird.messagebird_get_hlr_lookup '{"phone_number":"example_phone_number"}' --json kosmo integrations:messagebird messagebird_get_hlr_lookup '{"phone_number":"example_phone_number"}' --json messagebird.messagebird_request_hlr_lookup
Request a MessageBird HLR lookup for a phone number.
write - Parameters
- phone_number, options
kosmo integrations:call messagebird.messagebird_request_hlr_lookup '{"phone_number":"example_phone_number","options":"example_options"}' --json kosmo integrations:messagebird messagebird_request_hlr_lookup '{"phone_number":"example_phone_number","options":"example_options"}' --json messagebird.messagebird_create_verify
Create a MessageBird Verify request and send a token.
write - Parameters
- recipient, options
kosmo integrations:call messagebird.messagebird_create_verify '{"recipient":"example_recipient","options":"example_options"}' --json kosmo integrations:messagebird messagebird_create_verify '{"recipient":"example_recipient","options":"example_options"}' --json messagebird.messagebird_get_verify
Get a MessageBird Verify request by ID.
read - Parameters
- id
kosmo integrations:call messagebird.messagebird_get_verify '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_get_verify '{"id":"example_id"}' --json messagebird.messagebird_verify_token
Verify a token for a MessageBird Verify request.
write - Parameters
- id, token
kosmo integrations:call messagebird.messagebird_verify_token '{"id":"example_id","token":"example_token"}' --json kosmo integrations:messagebird messagebird_verify_token '{"id":"example_id","token":"example_token"}' --json messagebird.messagebird_delete_verify
Delete a MessageBird Verify request.
write - Parameters
- id
kosmo integrations:call messagebird.messagebird_delete_verify '{"id":"example_id"}' --json kosmo integrations:messagebird messagebird_delete_verify '{"id":"example_id"}' --json messagebird.messagebird_list_balance
Check your MessageBird account balance. Returns the available amount and payment type (prepaid or postpaid).
read - Parameters
- none
kosmo integrations:call messagebird.messagebird_list_balance '{}' --json kosmo integrations:messagebird messagebird_list_balance '{}' --json messagebird.messagebird_list_numbers
List purchased phone numbers in your MessageBird account. Supports filtering by country code and number type.
read - Parameters
- limit, offset, country_code, number_type
kosmo integrations:call messagebird.messagebird_list_numbers '{"limit":1,"offset":1,"country_code":"example_country_code","number_type":"example_number_type"}' --json kosmo integrations:messagebird messagebird_list_numbers '{"limit":1,"offset":1,"country_code":"example_country_code","number_type":"example_number_type"}' --json messagebird.messagebird_get_number
Get a purchased MessageBird phone number.
read - Parameters
- number
kosmo integrations:call messagebird.messagebird_get_number '{"number":"example_number"}' --json kosmo integrations:messagebird messagebird_get_number '{"number":"example_number"}' --json messagebird.messagebird_update_number
Update settings for a purchased MessageBird phone number.
write - Parameters
- number, settings
kosmo integrations:call messagebird.messagebird_update_number '{"number":"example_number","settings":"example_settings"}' --json kosmo integrations:messagebird messagebird_update_number '{"number":"example_number","settings":"example_settings"}' --json messagebird.messagebird_get_current_user
Get the current MessageBird account information, including balance and payment type.
read - Parameters
- none
kosmo integrations:call messagebird.messagebird_get_current_user '{}' --json kosmo integrations:messagebird messagebird_get_current_user '{}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
messagebird.messagebird_send_sms 4 parameters
kosmo integrations:schema messagebird.messagebird_send_sms --json | Parameter | Type | Required | Description |
|---|---|---|---|
originator | string | yes | Sender name or phone number (e.g., "OpenCompany" or "+3197012345678"). Max 11 characters for alphanumeric, or a valid phone number. |
recipients | array | yes | Array of recipient phone numbers in international format (e.g., ["+31612345678", "+447912345678"]). |
body | string | yes | The SMS text message body. Max 160 characters for a single SMS; longer messages are concatenated and charged accordingly. |
options | object | no | Optional MessageBird SMS parameters such as reference, scheduledDatetime, type, datacoding, validity, reportUrl. |
messagebird.messagebird_list_messages 7 parameters
kosmo integrations:schema messagebird.messagebird_list_messages --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of messages to return (default: 20, max: 1000). |
offset | integer | no | Offset for pagination (default: 0). |
status | string | no | Filter by message status: scheduled, sent, buffered, delivered, expired, delivery_failed. |
direction | string | no | Filter by direction: mt (outgoing / mobile terminated), mo (incoming / mobile originated). |
originator | string | no | Filter by originator. |
recipient | string | no | Filter by recipient. |
contact_id | string | no | Filter by contact ID. |
messagebird.messagebird_get_message 1 parameters
kosmo integrations:schema messagebird.messagebird_get_message --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The message ID (e.g., "a6e89f50c0d25b35a212345678901234"). |
messagebird.messagebird_delete_message 1 parameters
kosmo integrations:schema messagebird.messagebird_delete_message --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Message ID. |
messagebird.messagebird_send_voice_message 4 parameters
kosmo integrations:schema messagebird.messagebird_send_voice_message --json | Parameter | Type | Required | Description |
|---|---|---|---|
originator | string | yes | Sender phone number. |
recipients | array | yes | Recipient phone numbers or contact IDs. |
body | string | yes | Voice message text. |
options | object | no | Optional voice settings such as language, voice, repeat, ifMachine, machineTimeout, scheduledDatetime. |
messagebird.messagebird_list_voice_messages 6 parameters
kosmo integrations:schema messagebird.messagebird_list_voice_messages --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum results. |
offset | integer | no | Pagination offset. |
originator | string | no | Filter by originator. |
recipient | string | no | Filter by recipient. |
status | string | no | Filter by voice message status. |
contact_id | string | no | Filter by contact ID. |
messagebird.messagebird_get_voice_message 1 parameters
kosmo integrations:schema messagebird.messagebird_get_voice_message --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Voice message ID. |
messagebird.messagebird_delete_voice_message 1 parameters
kosmo integrations:schema messagebird.messagebird_delete_voice_message --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Voice message ID. |
messagebird.messagebird_list_contacts 2 parameters
kosmo integrations:schema messagebird.messagebird_list_contacts --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum results. |
offset | integer | no | Pagination offset. |
messagebird.messagebird_create_contact 1 parameters
kosmo integrations:schema messagebird.messagebird_create_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
contact | object | yes | Contact payload with msisdn, firstName, lastName, customDetails. |
messagebird.messagebird_get_contact 1 parameters
kosmo integrations:schema messagebird.messagebird_get_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Contact ID. |
messagebird.messagebird_update_contact 2 parameters
kosmo integrations:schema messagebird.messagebird_update_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Contact ID. |
contact | object | yes | Contact fields to update. |
messagebird.messagebird_delete_contact 1 parameters
kosmo integrations:schema messagebird.messagebird_delete_contact --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Contact ID. |
messagebird.messagebird_list_contact_groups 1 parameters
kosmo integrations:schema messagebird.messagebird_list_contact_groups --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Contact ID. |
messagebird.messagebird_list_contact_messages 2 parameters
kosmo integrations:schema messagebird.messagebird_list_contact_messages --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Contact ID. |
params | object | no | Optional query parameters. |
messagebird.messagebird_list_groups 2 parameters
kosmo integrations:schema messagebird.messagebird_list_groups --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum results. |
offset | integer | no | Pagination offset. |
messagebird.messagebird_create_group 1 parameters
kosmo integrations:schema messagebird.messagebird_create_group --json | Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Group name. |
messagebird.messagebird_get_group 1 parameters
kosmo integrations:schema messagebird.messagebird_get_group --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Group ID. |
messagebird.messagebird_update_group 2 parameters
kosmo integrations:schema messagebird.messagebird_update_group --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Group ID. |
name | string | yes | New group name. |
messagebird.messagebird_delete_group 1 parameters
kosmo integrations:schema messagebird.messagebird_delete_group --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Group ID. |
messagebird.messagebird_list_group_contacts 2 parameters
kosmo integrations:schema messagebird.messagebird_list_group_contacts --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Group ID. |
params | object | no | Optional query parameters. |
messagebird.messagebird_add_contact_to_group 2 parameters
kosmo integrations:schema messagebird.messagebird_add_contact_to_group --json | Parameter | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | Group ID. |
contact_id | string | yes | Contact ID. |
messagebird.messagebird_remove_contact_from_group 2 parameters
kosmo integrations:schema messagebird.messagebird_remove_contact_from_group --json | Parameter | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | Group ID. |
contact_id | string | yes | Contact ID. |
messagebird.messagebird_lookup_phone_number 2 parameters
kosmo integrations:schema messagebird.messagebird_lookup_phone_number --json | Parameter | Type | Required | Description |
|---|---|---|---|
phone_number | string | yes | Phone number to look up. |
country_code | string | no | Optional ISO country code for national numbers. |
messagebird.messagebird_get_hlr_lookup 1 parameters
kosmo integrations:schema messagebird.messagebird_get_hlr_lookup --json | Parameter | Type | Required | Description |
|---|---|---|---|
phone_number | string | yes | Phone number. |
messagebird.messagebird_request_hlr_lookup 2 parameters
kosmo integrations:schema messagebird.messagebird_request_hlr_lookup --json | Parameter | Type | Required | Description |
|---|---|---|---|
phone_number | string | yes | Phone number. |
options | object | no | Optional HLR lookup parameters. |
messagebird.messagebird_create_verify 2 parameters
kosmo integrations:schema messagebird.messagebird_create_verify --json | Parameter | Type | Required | Description |
|---|---|---|---|
recipient | string | yes | Phone number or email to verify. |
options | object | no | Optional verify parameters: originator, reference, type, template, timeout, tokenLength, datacoding. |
messagebird.messagebird_get_verify 1 parameters
kosmo integrations:schema messagebird.messagebird_get_verify --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Verify ID. |
messagebird.messagebird_verify_token 2 parameters
kosmo integrations:schema messagebird.messagebird_verify_token --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Verify ID. |
token | string | yes | Token sent to the recipient. |
messagebird.messagebird_delete_verify 1 parameters
kosmo integrations:schema messagebird.messagebird_delete_verify --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Verify ID. |
messagebird.messagebird_list_balance 0 parameters
kosmo integrations:schema messagebird.messagebird_list_balance --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
messagebird.messagebird_list_numbers 4 parameters
kosmo integrations:schema messagebird.messagebird_list_numbers --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of numbers to return (default: 20). |
offset | integer | no | Offset for pagination (default: 0). |
country_code | string | no | Filter by ISO 3166-1 alpha-2 country code (e.g., "NL", "US", "GB"). |
number_type | string | no | Filter by number type: mobile, landline. |
messagebird.messagebird_get_number 1 parameters
kosmo integrations:schema messagebird.messagebird_get_number --json | Parameter | Type | Required | Description |
|---|---|---|---|
number | string | yes | Purchased phone number. |
messagebird.messagebird_update_number 2 parameters
kosmo integrations:schema messagebird.messagebird_update_number --json | Parameter | Type | Required | Description |
|---|---|---|---|
number | string | yes | Purchased phone number. |
settings | object | yes | Number settings to update. |
messagebird.messagebird_get_current_user 0 parameters
kosmo integrations:schema messagebird.messagebird_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.