Messaging Channels Resource

Manage Messaging channels. You can get Messaging channels using the GET method. If a channel doesn't already have an ID, you can add and register it by taking the data from the GET method and passing it to the POST method.

Resource

1/connect/livemessage/channels

Available version

44.0

HTTP methods

GET, POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`authProviderId`	String	ID of the authentication provider record that the user created during authentication. If this value is not provided, the request only queries the org and doesn't query any external sources. If this value is provided, it must have a valid, unexpired token.	Optional	44.0
`cursor`	String	Paged cursor position. The response to a GET can be paged. If it is paged, we provide a cursor in the response. Passing that cursor as an argument to the next GET request provides the next page. If the cursor is missing from the response, there are no additional pages. If the cursor is not passed as an argument, the first page is returned.	Optional	44.0
`limit`	Integer	Maximum number of channels to return in the response to the GET request. If provided, the response is paged. If not provided, the response contains all channels, which can take some time if you have many channels.	Optional	44.0
`messageType`	String	Type of channel. Values are: `Facebook`—A Facebook message. `Line`—A LINE message. `Text`—A text message.	Required if the `authProviderId` is given	44.0

Response body for GET

Messaging Channels

Request body for POST

Root XML tag

<messagingChannel>

JSON example

1{
2  "messageType": "Facebook",
3  "messagingPlatformKey": "234420552541404",
4  "externalAccountId": "394847389739"
5}

Properties

Name	Type	Description	Required or Optional	Available Version
`externalAccountId`	String	ID of an account of the external channel specified in `messageType`.		57.0
`messageType`	String	Type of channel. Values are: `Facebook`—A Facebook message.	Required	44.0
`messagingPlatformKey`	String	ID of the Messaging channel on the external service. This value can be found in the GET response.	Required	44.0

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`authProviderId`	String	ID of the authentication provider record that the user created during authentication.	Required	44.0

Response body for POST

Messaging Channel

Connect REST API Developer Guide

Messaging Channels Resource