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

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

GEThttps://CONNECT-DOMAIN/api/v1/customer/permissions

Authorization

sfsAuthentication

Response

200401403

List of permissions found

Body

application/json

permissionsarray of list-permission-response (string)

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/permissions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

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

List advisor's permissions

List advisor's permissions (recommended)

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

GEThttps://CONNECT-DOMAIN/api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions

Authorization

sfsAuthentication

Path parameters

advisorSymphonyId*string

Advisor's Symphony user ID

externalNetwork*string

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

Response

200401403404

List of advisor's permissions

Body

application/json

advisorSymphonyIdstring

externalNetworkstring

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

permissionsarray of permission-response (object)

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "advisorSymphonyId": 14362370637825,
  "externalNetwork": "WHATSAPP",
  "permissions": [
    {
      "permissionName": "create:room"
    }
  ]
}

List EMP permissions

List EMP Permissions

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

GEThttps://CONNECT-DOMAIN/api/v1/customer/externalNetwork/{externalNetwork}/permissions

Authorization

sfsAuthentication

Path parameters

externalNetwork*string

The external network.

Response

200

List of EMP permissions found

Body

application/json

permissionsarray of enhanced-permission-response (object)

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/externalNetwork/{externalNetwork}/permissions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

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

Add permission to an advisor

Add permission to an advisor (recommended)

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.

POSThttps://CONNECT-DOMAIN/api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions

Authorization

sfsAuthentication

Path parameters

advisorSymphonyId*string

Advisor's Symphony user ID

externalNetwork*string

The external network

Body

application/json

permissionName*string

Response

200401403404409

Permission successfully added to the advisor

Body

application/json

advisorSymphonyIdstring

externalNetworkstring

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

permissionpermission-response (object)

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "permissionName": "create:room"
    }),
});
const data = await response.json();

Response

{
  "advisorSymphonyId": 14362370637825,
  "externalNetwork": "WHATSAPP",
  "permission": {
    "permissionName": "create:room"
  }
}

Add permission to multiple advisors

Add a permission to multiple advisors (recommended)

Grant permission to multiple advisors.

POSThttps://CONNECT-DOMAIN/api/v2/customer/advisors/permissions

Authorization

sfsAuthentication

Body

application/json

advisorSymphonyIds*array of string

externalNetwork*string

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

permissionName*string

Response

200401403404409

Permission successfully added to the advisor

Body

application/json

advisorsPermissionsarray of object

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v2/customer/advisors/permissions', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "advisorSymphonyIds": [
        1234567890
      ],
      "externalNetwork": "WHATSAPP",
      "permissionName": "create:room"
    }),
});
const data = await response.json();

Response

{
  "advisorsPermissions": [
    {
      "status": 200,
      "response": {
        "advisorSymphonyId": "12345678912365",
        "email": "[e-mail]",
        "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)

Remove a permission from an advisor.

DELETEhttps://CONNECT-DOMAIN/api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions/{permissionName}

Authorization

sfsAuthentication

Path parameters

advisorSymphonyId*string

Advisor's Symphony user ID

externalNetwork*string

The external network

permissionName*string

permissionName to remove

Response

204401403404

Permission successfully removed

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v2/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/permissions/{permissionName}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();