Skip to main content

Get DID Group by ID

This request returns data for a DID group, targeted by ID.

get/didGroups/{id}

Sample Request

This is a sample GET request to retrieve a DID group by its ID:

curl -X GET \
'https://api.carrierx.com/conference/v1/didGroups/219' \
-u '[your_user_name]:[your_password]'

Response

200 status code with a serialized copy of the DID Group object:

{
"attributes": [],
"callFlowId": 3,
"description": "",
"dids": [
{
"attributes": [],
"countryCode": "US",
"didGroupId": 219,
"id": 221,
"phoneNumber": "15162065319",
"state": -1
},
{
"attributes": [],
"countryCode": "US",
"didGroupId": 219,
"id": 220,
"phoneNumber": "15162065318",
"state": -1
}
],
"id": 219,
"name": "sample_conference_008_didGroup",
"state": -1,
"subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
}

This request is enabled for Field Filtering.

Path Arguments

ParameterData TypeDescription
id
required
integerThe ID of the DID group.