cam · 2019-01-16

ListGroups

POST

Query the list of user groups.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cam/ListGroups path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://cam.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cam/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cam.api3.convergecloud.com' \
  -H 'X-TC-Action: ListGroups' \
  -H 'X-TC-Version: 2019-01-16' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
Page	integer	—	Page number; default is 1
Rp	integer	—	Number of entries per page; default is 20
Keyword	string	—	Filter by User Group name

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
TotalNum	integer	Total number of User Groups
GroupInfo	GroupInfo[]	User group information array
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalNum": …,
    "GroupInfo": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cam.

SecretIdSecretKey

Request bodyvalid JSONPOST cam.api3.convergecloud.com · ListGroups

{}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "GroupInfo": [
      {
        "Channel": 3,
        "CreateTime": "2026-09-11 11:58:11",
        "GroupId": 1373,
        "GroupName": "OCM-Pipeline",
        "GroupNum": 1,
        "GroupType": 0,
        "Remark": "",
        "UserInfo": []
      }
    ],
    "Remark": "",
    "RequestId": "68e9d3e8-a6ad-d466-1fef-08676f546375",
    "TotalNum": 1,
    "UserInfo": null
  }
}