Skip to main content

DID Line Information Object

This section goes over the parts of the Line Information object.

DID Line Information Object Attributes

These fields and values make up the JSON response that gets returned when a request is successful.

info

To enable this feature on your account, contact technical support at support@carrierx.com.

AttributeData TypeDescription
caller_namestringThe name that will appear on receiving party phones.
class_of_servicestringThe type of establishment that the service is for. Values accepted in this field are:
  • business
  • none
  • residential
The default value is none.
enabledbooleanIf this field is set to false, no record is stored in the central CNAM registry. Fields can still be updated when the value is false.
extended_business_namestringThe business name associated with the caller. This extended information is given according to the provider and phone device.
extended_first_namestringThe first name of the caller. This extended information is given according to the provider and phone device.
extended_last_namestringThe last name of the caller. This extended information is given according to the provider and phone device.
privacystringEither public or private. This is whether or not the caller name will be displayed. The default is public.
screeningstringDetermines what types of calls are accepted. Values accepted in this field are:
  • allow_all to allow all calls.
  • block_collect to block collect calls.
  • block_third_number to block third number (operator assisted) calls.
  • block_third_number_collect to block third number (operator assisted) and collect calls.
The default value is block_third_number_collect.

Sample DID Line Information Object

{
"caller_name": "John Smith",
"class_of_service": "business",
"enabled": true,
"extended_business_name": "J Smith Carpenter",
"extended_first_name": "John",
"extended_last_name": "Smith",
"privacy": "public",
"screening": "allow_all"
}