Permissions API

Always use the Copy icon in the example field when copying examples. Manual copy and paste is known to cause data format errors.

List permissions

List permissions

get

List of available permissions for the external network at "CONNECT-DOMAIN"

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Responses

200

List of permissions found

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

get

/api/v1/customer/permissions

HTTPcURLJavaScriptPython

GET /api/v1/customer/permissions HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "permissions": [
    "create:room"
  ]
}

List advisor's permissions

List advisor's permissions (recommended)

get

List the permissions granted to an advisor on an external network.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

advisorSymphonyIdstringRequired

Advisor's Symphony user ID

Example: 1234567890

externalNetworkstringRequired

The external network: WECHAT or WHATSAPP or SMS or SMS-DIRECT or LINE

Example: WHATSAPP

Responses

200

List of advisor's permissions

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Advisor not found

application/json

get

/api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions

HTTPcURLJavaScriptPython

GET /api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "advisorSymphonyId": 14362370637825,
  "externalNetwork": "WHATSAPP",
  "permissions": [
    {
      "permissionName": "create:room",
      "permissionId": "aef488fa-636e-483e-b366-278e07354e57"
    }
  ]
}

List EMP permissions

List EMP Permissions

get

List all permissions available for the external network at "CONNECT-DOMAIN" For each permission, returns id, name and whether they are set by default or not

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

externalNetworkstringRequired

The external network.

Example: WHATSAPP

Responses

200

List of EMP permissions found

application/json

get

/api/v1/customer/externalNetwork/{externalNetwork}/permissions

HTTPcURLJavaScriptPython

GET /api/v1/customer/externalNetwork/{externalNetwork}/permissions HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of EMP permissions found

{
  "permissions": [
    {
      "isDefault": true,
      "permissionId": "text",
      "permissionName": "text"
    }
  ]
}

Add permission to an advisor

Add permission to an advisor (recommended)

post

Grant permission to an advisor.
Refer to the Permissions table on the Authentication page for the default permissions.
For multi-company contacts, the contacts must be from the same network, e.g. all from WeChat or all from WhatsApp. Cross-network rooms are not authorized.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

advisorSymphonyIdstringRequired

Advisor's Symphony user ID

Example: 1234567890

externalNetworkstringRequired

The external network

Body

application/json

permissionNamestringRequiredExample: create:room

Responses

200

Permission successfully added to the advisor

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Not found

application/json

409

Conflict

application/json

post

/api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions

HTTPcURLJavaScriptPython

POST /api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "permissionName": "create:room"
}

{
  "advisorSymphonyId": 14362370637825,
  "externalNetwork": "WHATSAPP",
  "permission": {
    "permissionName": "create:room",
    "permissionId": "aef488fa-636e-483e-b366-278e07354e57"
  }
}

Add permission to multiple advisors

Add a permission to multiple advisors (recommended)

post

Grant permission to multiple advisors.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Body

application/json

advisorSymphonyIdsstring[]RequiredExample: 1234567890

externalNetworkstringRequired

External network: WECHAT or WHATSAPP or SMS or SMS-DIRECT or LINE

Example: WHATSAPP

permissionNamestringRequiredExample: create:room

Responses

200

Permission successfully added to the advisor

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Not found

application/json

409

Conflict

application/json

post

/api/v2/customer/advisors/permissions

HTTPcURLJavaScriptPython

POST /api/v2/customer/advisors/permissions HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "advisorSymphonyIds": [
    1234567890
  ],
  "externalNetwork": "WHATSAPP",
  "permissionName": "create:room"
}

{
  "advisorsPermissions": [
    {
      "status": 200,
      "response": {
        "advisorSymphonyId": "12345678912365",
        "email": "[email protected]",
        "externalNetwork": "External network: WECHAT or WHATSAPP or SMS or SMS-DIRECT or LINE",
        "permission": {
          "permissionName": "create:room"
        }
      },
      "error": {
        "title": "advisor.not.found",
        "detail": "Advisor 68719476737 does not exist"
      }
    }
  ]
}

Remove permission

Remove permission (recommended)

delete

Remove a permission from an advisor.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

advisorSymphonyIdstringRequired

Advisor's Symphony user ID

externalNetworkstringRequired

The external network

permissionNamestringRequired

permissionName to remove

Responses

204

Permission successfully removed

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Advisor not found

application/json

delete

/api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions/{permissionName}

HTTPcURLJavaScriptPython

DELETE /api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions/{permissionName} HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content