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

get

List all federation groups

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Query parameters

beforestringOptional

The before cursor for pagination

afterstringOptional

The after cursor for pagination

Responses

200

List of federation groups

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

get

/api/v1/customer/federationGroups

HTTPcURLJavaScriptPython

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

{
  "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.

put

Update advisor's federation group for the 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

advisorSymphonyIdstringRequired

Advisor's Symphony user ID

Example: 12345678912365

Body

application/json

federationGroupIdstringRequiredExample: company-federation-group1

moveToDefaultbooleanOptional

Responses

204

The advisor's federation group is updated successfully.

400

Missing or malformed input

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Not found

application/json

put

/api/v1/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/federationGroup

HTTPcURLJavaScriptPython

PUT /api/v1/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/federationGroup HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "federationGroupId": "company-federation-group1",
  "moveToDefault": true
}

No content

Bulk update advisor(s) federation group(s)

Bulk update advisor's federation group

post

Bulk update advisor's federation group.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Body

application/json

Responses

200

The advisor's federation group is updated successfully.

application/json

400

Missing or malformed input

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Not found

application/json

post

/api/v1/customer/advisors/federationGroup/bulk

HTTPcURLJavaScriptPython

POST /api/v1/customer/advisors/federationGroup/bulk HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "request": [
    {
      "symphonyId": 1234512345,
      "externalNetwork": "WHATSAPP",
      "federationGroupId": "company-federation-group1"
    },
    {
      "symphonyId": 1357913579,
      "externalNetwork": "WHATSAPP",
      "federationGroupId": "company-federation-group2"
    }
  ]
}

{
  "responses": [
    {
      "status": 1,
      "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

put

Set the federation group of a room.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

streamIdstringRequired

StreamId of the room to transfer

Body

application/json

federationGroupIdstringOptionalExample: 123456789

moveToDefaultbooleanOptionalExample: true

Responses

204

The room's federation group has been updated successfully.

400

Missing or malformed input

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Not found

application/json

409

Conflict

application/json

put

/api/v1/customer/rooms/{streamId}/federationGroup

HTTPcURLJavaScriptPython

PUT /api/v1/customer/rooms/{streamId}/federationGroup HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "federationGroupId": 123456789,
  "moveToDefault": true
}

No content