Skip to Content

Edit a Message Channel

Edit a message channel.

Note: This API endpoint can be used to edit an SMS channel, WhatsApp channel, or Facebook channel. To edit a Live Chat channel, see Edit a Live Chat Channel.

Request URL

POST {base_url}/{api_path}/message_channel/update?access_token={access_token}

Request parameters

Send different request parameters according to different types of message channel.

  • Edit an SMS channel
  • Edit a WhatsApp channel
  • Edit a Facebook channel

Edit an SMS channel

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of the message channel.Note:You can query the message channel ID using Search Specific Message Channels.
nameNoStringMessage channel name.Note:The length must not exceed 127 characters.
webhook_url_typeNoStringThe type of domain used in the Webhook URL.Valid value:
  • fqdn
  • nat
account_dataNoArray<Auth_Info>The data required by the service provider for message channel connection.
send_rateNoIntegerSpecify the number of messages that PBX can send per second via the message channel.
auto_close_sessionNoIntegerWhether to automatically close a message session after it has been inactive for a specified period of time.
session_expired_timeNoIntegerThe duration of inactivity (in days) after which a session is automatically closed.
enb_duplicate_active_sessionNoIntegerWhether to allow creating a new session when an active session with the same sender and receiver already exists.
Valid value:
  • 0: Disallow (default).
  • 1: Allow. A new session can be created even if an active session with the same sender and receiver already exists. After creation, the original session will be removed from the previous handler's session list and taken over by the new creator with the complete chat history.
accompanying_msgNoStringThe accompanying text content for chat file.Note:This parameter is REQUIRED when creating an Apidaze SMS channel.
didsNoArray<Msg_Routing>Define the message routing rule by adding the DID number(s), setting message destination, and specifying members that are allowed to initiate message sessions via specified DID number.

Auth_InfoNote:Provide the required parameter values according to the requirements of different SMS service providers.

ParameterRequiredTypeDescription
kYesStringThe name of the key field required by the service provider.Valid value:

  • For General / Alhambra IT / Athenna / IXICA / NETPLANET / Vetta / VoIP.ms / Voxtelesys

    • api_key
    • api_secret (Optional)
    • api_verify_url (Optional): API endpoint for authentication verification.
    • api_send_url: API endpoint for sending messages.

  • For Apidaze

    • api_key
    • api_secret

  • For Aspsms

    • user_key
    • password

  • For Bandwidth

    • application_id
    • account_id
    • username
    • password

  • For Flowroute / SIPTRUNK

    • access_key
    • secret_key

  • For Skyetel

    • sid_key
    • secret_key

  • For Telnyx

    • api_key
    • public_key

  • For Twilio

    • account_sid
    • auth_token

  • For VoiceMeUp

    • username
    • auth_token
vYesStringThe value associated with the key field k.

Valid value:

  • If k is api_verify_url or api_send_url, enter the API endpoint as https://{{your-endpoint}}.
  • For all other key fields, enter the key value in Base64-encoded format.

Msg_RoutingImportant:Always submit all fields you wish to retain, as partial updates are not supported. Fields omitted from the request body will be cleared or reset to default values.

ParameterRequiredTypeDescription
idNoIntegerThe unique ID of an existing DID number.Note:
did_numberYesStringThe DID number associated with the message channel.
destination_typeYesStringThe type of the destination.

Valid value:

  • extension: Extension user.
  • queue: Message queue.
  • api: Third-party message analytics platform (via API).
destination_idNoStringThe unique ID of destination to which inbound messages are sent.Note:
membersNoArray<Members>The members that are allowed to initiate message sessions using the DID number.

Members

ParameterRequiredTypeDescription
typeYesStringMember type.

Valid value:

  • extension
  • ext_group
  • organization
valueYesStringThe unique ID of the member.
Note:You can query the member ID using Get Menu Options (menu=extension/ext_group/org_list).

Edit a WhatsApp channel

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of the message channel.Note:You can query the message channel ID using Search Specific Message Channels.
nameNoStringMessage channel name.Note:The length must not exceed 127 characters.
webhook_url_typeNoStringThe type of domain used in the Webhook URL.
Valid value:
  • fqdn
  • nat
account_dataNoArray<Auth_Info>The data required by the service provider for message channel connection.
phone_number_idNoStringThe ID of the WhatsApp phone number.
Note: The length must not exceed 31 characters.
business_account_idNoStringThe ID of the WhatsApp business account.
Note:
  • The value should be passed in Base64-encoded format.
  • The length must not exceed 500 characters.
didsNoArray<Msg_Routing>Define the message routing rule by adding the WhatsApp phone number, setting message destination, and specifying members that are allowed to initiate message sessions via the phone number.
auto_close_sessionNoIntegerWhether to automatically close a message session after it has been inactive for a specified period of time.
session_expired_timeNoIntegerThe duration of inactivity (in days) after which a session is automatically closed.
enb_duplicate_active_sessionNoIntegerWhether to allow creating a new session when an active session with the same sender and receiver already exists.
Valid value:
  • 0: Disallow (default).
  • 1: Allow. A new session can be created even if an active session with the same sender and receiver already exists. After creation, the original session will be removed from the previous handler's session list and taken over by the new creator with the complete chat history.

Auth_Info

ParameterRequiredTypeDescription
kYesStringThe name of the key field required by the service provider.
Valid value:
  • access_token
  • app_secret
vYesStringThe value associated with the key field k.
Note:The value should be passed in Base64-encoded format.

Msg_Routing

ParameterRequiredTypeDescription
did_numberYesStringThe WhatsApp phone number in E.164 format.
destination_typeYesStringThe type of the destination.

Valid value:

  • extension: Extension user.
  • queue: Message queue.
  • api: Third-party message analytics platform (via API).
destination_idNoStringThe unique ID of destination to which inbound messages are sent.
Note:
membersNoArray<Members>The members that are allowed to initiate message sessions via the WhatsApp phone number.

Members

ParameterRequiredTypeDescription
typeYesStringMember type.

Valid value:

  • extension
  • ext_group
  • organization
valueYesStringThe unique ID of the member.
Note:You can query the member ID using Get Menu Options (menu=extension/ext_group/org_list).

Edit a Facebook channel

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of the message channel.
Note:You can query the message channel ID using Search Specific Message Channels.
nameNoStringMessage channel name.
Note:The length must not exceed 127 characters.
webhook_url_typeNoStringThe type of domain used in the Webhook URL.
Valid value:
  • fqdn
  • nat
account_dataNoArray<Auth_Info>The data required by the service provider for message channel connection.
didsNoArray<Msg_Routing>Define the message routing rule by adding the Facebook page ID and setting message destination.
auto_close_sessionNoIntegerWhether to automatically close a message session after it has been inactive for a specified period of time.
session_expired_timeNoIntegerThe duration of inactivity (in days) after which a session is automatically closed.

Auth_Info

ParameterRequiredTypeDescription
kYesStringThe name of the key field required by the service provider.
Valid value:
  • access_token
  • app_secret
  • page_name
vYesStringThe value associated with the key field k.
Note: For access_token and app_secret fields, enter the value in Base64-encoded format.

Msg_Routing

ParameterRequiredTypeDescription
did_numberYesStringFacebook page ID.
destination_typeYesStringThe type of the destination.

Valid value:

  • extension: Extension user.
  • queue: Message queue.
  • api: Third-party message analytics platform (via API).
destination_idNoStringThe unique ID of destination to which inbound messages are sent.
Note:

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example

Change the destination of a DID number (ID: 5) in an SMS channel (ID: 267).

POST /openapi/v1.0/message_channel/update?access_token=ybE6c2R2617EOQnaLAWaoiUEbC1NvTug HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json

{
    "id":267,
    "dids":[
      {
        "id":5,
        "did_number":"+12125551234",
        "destination_type":"api",        //Change destination to Third-party message analytics platform (transmitted via API).
        "members":
         [
           {
              "type":"organization",  
              "value":"3"
            },
            {
               "type":"extension",  
               "value":"137"
            }
          ]

     },
   //  All entries must be included in the update request; otherwise, missing entries will be cleared.
    {
        "id":3,
        "did_number":"+442079460857",
        "destination_type":"extension",
        "destination_id":"137",
        "members":[
            {
              "type":"extension",  
              "value":"137"
            }
          ]
      }
   ]
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}