Federation Group 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 all federation groups

List all federation groups

List all federation groups

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

Authorization

sfsAuthentication

Query parameters

Response

200401403

List of federation groups

Body

application/json

federationGroupsarray of list-federation-groups-item-response (object)

paginationPagination

Request

JavaScriptCurl

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

Response

{
  "federationGroups": [
    {
      "federationGroupId": "company-federation-group1",
      "federationGroupName": "federationGroup",
      "activeExternalNetworks": [
        "WHATSAPP"
      ]
    }
  ],
  "pagination": {
    "previous": "?before=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "next": "?after=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "cursors": {
      "before": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
      "after": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9"
    }
  }
}

Update advisor's federation group for the given external network

Update advisor's federation group for the given external network.

Update advisor's federation group for the given external network.

PUThttps://CONNECT-DOMAIN/api/v1/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/federationGroup

Authorization

sfsAuthentication

Path parameters

externalNetwork*string

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

advisorSymphonyId*string

Advisor's Symphony user ID

Body

application/json

federationGroupId*string

Response

204400401403404

The advisor's federation group is updated successfully.

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/federationGroup', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "federationGroupId": "company-federation-group1"
    }),
});
const data = await response.json();

Bulk update advisor(s) federation group(s)

Bulk update advisor's federation group

Bulk update advisor's federation group.

POSThttps://CONNECT-DOMAIN/api/v1/customer/advisors/federationGroup/bulk

Authorization

sfsAuthentication

Body

application/json

requestarray of bulk-update-federation-group-item-request (object)

Response

200400401403404

The advisor's federation group is updated successfully.

Body

application/json

responsesarray of bulk-update-federation-group-item-response (object)

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/advisors/federationGroup/bulk', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "symphonyId": 1234512345,
        "externalNetwork": "WHATSAPP",
        "federationGroupId": "company-federation-group1"
      },
      {
        "symphonyId": 1357913579,
        "externalNetwork": "WHATSAPP",
        "federationGroupId": "company-federation-group2"
      }
    ]),
});
const data = await response.json();

Response

{
  "responses": [
    {
      "response": {
        "symphonyId": 123456789,
        "federationGroupId": "company-federation-group1",
        "externalNetwork": "WHATSAPP"
      },
      "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"
        }
      }
    }
  ]
}

Set federation group of a room

Set federation group of a room

Set the federation group of a room.

PUThttps://CONNECT-DOMAIN/api/v1/customer/rooms/{streamId}/federationGroup

Authorization

sfsAuthentication

Path parameters

streamId*string

StreamId of the room to transfer

Body

application/json

federationGroupIdstring

moveToDefaultboolean

Response

204400401403404409

The room's federation group has been updated successfully.

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/rooms/{streamId}/federationGroup', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();