Skip to main content

Create message settings

POST 

/api/v1/domains/:domain_uuid/message-settings

Configures a messaging phone number for an account. Supply the phone number, its message provider, and any extensions that should share it. National numbers are automatically converted to E.164 using the account country or the country in Default Settings. If neither is configured, supply an international number with + and its country code. Numbers starting with + use their supplied country code. Allowed extensions can send and receive messages using the number and see each other's replies. An empty or omitted extension list grants no extension access.

Incoming delivery defaults to inherit: use the account webhook when configured, otherwise use the number's members and email. Choose members to use local members and email regardless of the account webhook, or webhook with a public HTTPS inbound_webhook_url to forward only to that URL. Custom webhook delivery clears local members and email, including values supplied in this request.

Webhooks use the account's shared HMAC-SHA256 signing secret, generated if absent. This API does not return or accept changes to the secret. Authorized administrators can retrieve it in Account Settings > Messaging or the number's Message Settings form. Receivers verify the Signature header against the raw JSON request body and return HTTP 2xx. Webhook-routed SMS/MMS remain in administrative logs and bypass local conversations and email. Changes affect newly received messages.

The number is enabled by default. This endpoint saves the configuration in FS PBX; it does not purchase a number or configure your provider's account. Requires account access and message_settings_manage.

Request​

Responses​