Connect a Member Account with LINE or LINE WORKS
Connects an individual member account in a specified domain with LINE or LINE WORKS.
When you connect with LINE or LINE WORKS, "External Messaging" is enabled. Go to LINE WORKS Admin and click [Service > External Messaging > Configure Connected-member list] to check your connection status.
API Type
Server API
Request URL
https://apis.worksmobile.com/r/{API ID}/contact/v2/domains/{domainId}/worksats/{worksAtType}/accounts/{accountId}
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Request
- PathVariable
Parameter | Type | Required | Description |
---|---|---|---|
domainId | Integer | Y | Domain ID |
worksAtType | String | Y | Message type to connect ● line: LINE ● worksat: LINE WORKS |
accountId | String | Y | Account of a member to be added |
Request Example
https://apis.worksmobile.com/r/{API ID}/contact/v2/domains/1/worksats/line/accounts/account1@example.com
Response
- SUCCESS
HTTP Response Code : 200
Empty body
""
Error Code
It returns an error code and message when the API call fails.
HTTP status | Error Code | Description |
---|---|---|
400 | INVALID_PARAMETER | Invalid request parameters |
404 | NOT_FOUND | No user exists for the accountId |
500 | INTERNAL_SERVER_ERROR | Internal server error |
Error Code Example
{
"code": "NOT_FOUND",
"message": "accountId contains NG Word"
}