Entitlements 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 entitlements

List entitlements (recommended)

get

List the available entitlements.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Responses

200

List of found entitlements

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

get

/api/v2/customer/entitlements

HTTPcURLJavaScriptPython

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

{
  "entitlements": [
    "WECHAT",
    "WHATSAPP",
    "SMS",
    "SMS-DIRECT",
    "LINE"
  ]
}

Add entitlement

Add entitlement (recommended)

post

Entitle a Symphony user to use the external network.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Body

application/json

advisorEmailAddressstringOptionalExample: [email protected]

externalNetworkstringRequired

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

Example: WHATSAPP

symphonyIdstringOptionalExample: 12345678912365

advisorPhoneNumberstring · phoneOptional

Required for the advisor to access SMS Direct In-Network and supported for SMS Direct Second-Number. Supported for the advisor to access WhatsApp Direct. However, note that the advisor’s phone number is not applicable for onboarding the advisor to other external networks (WeChat, WhatsApp, SMS or LINE).

permissionsstring[]Optional

federationGroupIdstringOptionalExample: federationGroupId

Responses

201

The user has successfully been added in the list of entitlements.

application/json

400

Missing or malformed input

application/json

401

Unauthorized

application/json

403

Add user forbidden

application/json

404

Not found

application/json

409

Conflict

application/json

500

Server error (SMS-Direct Second Number only)

application/json

post

/api/v2/customer/entitlements

HTTPcURLJavaScriptPython

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

{
  "advisorEmailAddress": "[email protected]",
  "externalNetwork": "WHATSAPP",
  "symphonyId": 12345678912365,
  "advisorPhoneNumber": "text",
  "permissions": [
    "text"
  ],
  "federationGroupId": "federationGroupId"
}

{
  "symphonyId": 14362370637825,
  "firstName": "William",
  "lastName": "Smith",
  "companyName": "Company",
  "displayName": "William Smith",
  "emailAddress": "[email protected]",
  "avatar": "https://YOURDOMAIN.symphony.com/avatars/3gXMhglCCTwLPL9JAprnyHzYn5-PR49-wYDG814n1g8.png",
  "externalNetwork": "WHATSAPP",
  "permissions": [
    {
      "status": 200,
      "response": {
        "permissionName": "create:room",
        "permissionId": "aef488fa-636e-483e-b366-278e07354e57"
      },
      "error": {
        "itemId": "text",
        "type": "https://zalando.github.io/problem/constraint-violation",
        "title": "text",
        "statusCode": 503,
        "detail": "Connection to database timed out",
        "instance": "https://example.com",
        "parameters": {
          "additionalProp1": "text",
          "additionalProp2": "text",
          "additionalProp3": "text"
        }
      }
    }
  ],
  "federationGroupId": "federationGroupId",
  "ownContactId": 14362370637825,
  "status": "PRE_ENTITLED",
  "phone": {
    "number": "[phone]",
    "product": "PRE_ALLOCATED_HOSTED",
    "subNetwork": "SECOND-NUMBER",
    "provider": "UMONY"
  }
}

List entitled advisors

List entitled advisors

get

List all entitled advisors on a given external network.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

externalNetworkstringRequired

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

Example: WHATSAPP

Query parameters

beforestringOptional

The before cursor for pagination

afterstringOptional

The after cursor for pagination

listPermissionsbooleanOptional

Boolean query parameter that indicates whether the search API will return the list of permissions per advisor return, or not

Default: falseExample: true

Responses

200

List of found entitled advisors.

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

get

/api/v1/customer/entitlements/externalNetwork/{externalNetwork}/advisors

HTTPcURLJavaScriptPython

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

{
  "entitlements": [
    {
      "symphonyId": "14362370637825",
      "firstName": "William",
      "lastName": "Smith",
      "companyName": "Company",
      "displayName": "William Smith",
      "emailAddress": "[email protected]",
      "avatar": "https://YOURDOMAIN.symphony.com/avatars/3gXMhglCCTwLPL9JAprnyHzYn5-PR49-wYDG814n1g8.png",
      "externalNetwork": "WHATSAPP_DIRECT",
      "federationGroupId": "federationGroupId",
      "status": "PRE_ENTITLED",
      "phone": {
        "number": "[phone]",
        "product": "PRE_ALLOCATED_HOSTED",
        "subNetwork": "SECOND-NUMBER",
        "provider": "UMONY"
      },
      "permissions": [
        {
          "permissionName": "create:room",
          "permissionId": "aef488fa-636e-483e-b366-278e07354e57"
        }
      ]
    }
  ],
  "pagination": {
    "previous": "?before=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "next": "?after=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "cursors": {
      "before": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
      "after": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9"
    }
  }
}

Get an advisor's entitlement

Get an advisor's entitlement (recommended)

get

Check if a given advisor is entitled for a given external network. Advisors can be identified using their email address or their Symphony user ID (if both are provided, the Symphony user ID will take precedence)

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Query parameters

advisorEmailAddressstringOptional

Symphony user email address

Example: [email protected]

advisorSymphonyIdstringOptional

Symphony user ID

Example: 12345678912365

externalNetworkstringRequired

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

Example: WHATSAPP

Responses

200

Advisor data (if an entitled advisor has been found)

application/json

400

Missing or malformed input

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Entitlement not found (if no entitled advisor matching the parameters has been found)

application/json

500

No available number

application/json

get

/api/v2/customer/advisor/entitlements

HTTPcURLJavaScriptPython

GET /api/v2/customer/advisor/entitlements?externalNetwork=WHATSAPP HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "symphonyId": "14362370637825",
  "firstName": "William",
  "lastName": "Smith",
  "companyName": "Company",
  "displayName": "William Smith",
  "emailAddress": "[email protected]",
  "avatar": "https://YOURDOMAIN.symphony.com/avatars/3gXMhglCCTwLPL9JAprnyHzYn5-PR49-wYDG814n1g8.png",
  "externalNetwork": "WHATSAPP_DIRECT",
  "federationGroupId": "federationGroupId",
  "status": "PRE_ENTITLED",
  "phone": {
    "number": "[phone]",
    "product": "PRE_ALLOCATED_HOSTED",
    "subNetwork": "SECOND-NUMBER",
    "provider": "UMONY"
  },
  "permissions": [
    {
      "permissionName": "create:room",
      "permissionId": "aef488fa-636e-483e-b366-278e07354e57"
    }
  ]
}

Remove entitlement

Remove entitlement (recommended)

delete

Removes a given advisor's entitlement for a given external network. Advisors can be identified using their email address or their Symphony user ID (if both are provided, the Symphony user ID will take precedence)

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Query parameters

advisorEmailAddressstringOptional

Advisor's email address

Example: [email protected]

advisorSymphonyIdstringOptional

Symphony user ID

Example: 12345678912365

externalNetworkstringRequired

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

Example: WHATSAPP

Responses

200

The entitlement has been successfully removed.

No content

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Entitlement not found

application/json

delete

/api/v2/customer/advisor/entitlements

HTTPcURLJavaScriptPython

DELETE /api/v2/customer/advisor/entitlements?externalNetwork=WHATSAPP HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content