Skip to main content

Account Object

In CarrierX API, the Account object describes the Conference endpoint account properties.

The system returns an Account JSON object with the fields listed in the table below in response to one of the following successful requests:

Account Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

AttributeData TypeDescription
account_sid
read only
stringThe account secure ID.
propertiesobjectThe call flow properties which will be overriden at the account level. Refer to this section for more details on various conference v2 call flow properties.
call_flow_sidstringThe secure ID of the default call flow associated with the account.
date_created
read only
stringThe date and time when the account was created.
login
read only
stringThe login username used to access the Conference endpoint. Each endpoint has a unique login and password.
namestringThe account name. This is a human-readable nickname for the account.
passwordstringThe account password. This field is hidden from the response and never returned as a plain text.

Sample Account Object

{
"account_sid": "993a6552-b73b-41e5-a501-a788377ca8ed",
"properties": {},
"call_flow_sid": "fb2b69b1-6998-4cdc-b04c-a267c585f767",
"date_created": "2021-02-25T20:36:54.000Z",
"login": "conference_user_123",
"name": "John Smith"
}