Category
User
User
Update a User
Update information of a particular User. Parameter Accessible via URL https://api.channel.io/open/v5/users/{userId} and HTTP PATCH Present parameters in PATCH body. This method does currently accept application/json only. Parameter Example Required Description Parameter type userId 5ec3a01fe2b3f4d2cbc5 Required ID of User Path profile {"name": "Gabrielle Chanel", ..} Optional Profile object contains user information Body profileOnce {"utmSource": "google", ..} Optional Profile object contains us
Upsert a User (By memberId)
If a User exists, update information. If it's not, create a new User. Parameter Accessible via URL https://api.channel.io/open/v5/users/@{memberId} and HTTP PUT Note that there is @ character in front of memberId Present parameters in PUT body. This method does currently accept application/json only. Parameter Example Required Description Parameter type memberId 12345 Required member (user) identification id used by your company Path profile {"name": "Gabrielle Chanel", ..} Optional Profile obje
Get a single User
Get a particular User object. You can get a particular User in two ways. First way is retrieve a User by userId (User identifier in channel talk server). Second is retrieve a User by memberId (User memberId that you used in javascript-quickstart.) Get a particular User by userId Parameter Accessible via URL https://api.channel.io/open/v5/users/{userId} and HTTP GET Parameter Example Required Description Parameter type userId 5ec3a01fe2b3f4d2cbc5 Required ID of User Path Example GET https://api.c
Delete a User
Delete a particular User. You can delete a particular User in two ways. First way, delete a User by userId (User identifier in channel talk server). Second, delete a User by memberId (User memberId that you used in javascript-quickstart.) Delete a particular User by userId Parameter Acccessible via URL https://api.channel.io/open/v5/users/{userId} and HTTP DELETE Parameter Example Required Description Parameter type userId 5ec3a01fe2b3f4d2cbc5 Required ID of User Path Example DELETE https://api.
Block a User
Block a particular User. Parameter Accessible via URL https://api.channel.io/open/v5/users/{userId}/block and HTTP POST Parameter Example Required Description Parameter type userId 12345 Required ID of User Path Example POST http://api.channel.io/open/v5/users/12345/block Response Returns changed User object along with related information { "user": { "id": "string", "channelId": "string", "memberId": "string", "veilId": "string", "unifiedId": "string", "type": "member", "name": "string", "mobile
Unblock a User
Unblock a particular User. Parameter Accessible via URL https://api.channel.io/open/v5/users/{userId}/block and HTTP DELETE Parameter Example Required Description Parameter type userId 12345 Required ID of User Path Example DELETE http://api.channel.io/open/v5/users/12345/block Response Returns changed User object along with related information { "user": { "id": "string", "channelId": "string", "memberId": "string", "veilId": "string", "unifiedId": "string", "type": "member", "name": "string", "
Create a User's UserChat
Create new UserChat of a particular User. Parameter Accessible via URL https://api.channel.io/open/v5/users/{userId}/user-chats and HTTP POST Parameter Example Required Description Parameter type userId 12345 Required ID of User Path Example POST https://api.channel.io/open/v5/users/12345/user-chats Response Return a newly created UserChat object { "campaign": { "id": "string", "channelId": "string", "name": "string", "state": "draft", "sendMedium": "appAlimtalk", "userQuery": { "key": "string",
Get a list of User's UserChats
Retrieve UserChat of a particular User. Parameter Accessible via URL https://api.channel.io/open/v5/users/{userId}/user-chats and HTTP GET Present parameters in query string Parameter Example Required Description Parameter type userId 12345 Required ID of User Path sortOrder desc Optional Sorting order. - available values : asc, desc, both - default value : desc (descending order means latest message first) Query since 500000 Optional Epoch time in microseconds of the first message to be retriev
Issue token for a User
Issue sessionJWT of a particular User. Parameter Accessible via URL https://api.channel.io/open/v5/users/@{memberId}/session-jwt/issue and HTTP PUT Parameter Example Required Description Parameter Type memberId 12345 Required memberIdofUser Path expiration PT30M Optional If this property is null,the expiration is set to 1 minute(PT1M). Query Example PUT https://api.channel.io/open/v5/users/@12345/session-jwt/issue?expiration=PT30M Response Returns an object which includes sessionJWT, and expireA