Endpoint Object

This section outlines the Endpoint object.

Endpoint Object Attributes

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

Attribute	Data Type	Description
addresses createupdate	array of objects	The endpoint addresses. Refer to the table below for more information.
attributes createupdate	object	The endpoint attributes. Refer to the table below for more information.
capacity createupdate	integer	The maximum number of simultaneous inbound calls.
cps_limit read only	integer	The maximum number of outbound calls per second. 0 or null means unlimited.
endpoint_sid read only	string	The endpoint secure ID.
name createupdate	string	The endpoint name.
out_sip_password create	string	For calls sent to this endpoint and if proxy authentication is required, this password and out_sip_username will be used if no sip_password is set for the Endpoint Address object.
out_sip_username create	string	For calls sent to this endpoint and if proxy authentication is required, this username and out_sip_password will be used if no sip_username is set for the Endpoint Address object.
partner read only	object	The Partner object associated with the endpoint. This field is displayed if with_related is set to true when performing the GET queries.
partner_sid create	string	The secure ID of the partner associated with the endpoint.
properties createupdate	object	The endpoint properties. Refer to the table below for more information.
transformations createupdate	array of objects	The transformations that apply to the endpoint. Refer to the transformations section for more information.
type create	string	The type of endpoint. Values accepted in this field are: conference for the hosted legacy endpoint that allows conference meeting rooms. conference_playback for the hosted endpoint helper for Conference to allow playback of recorded files. conference_v2 for the hosted new endpoint that allows conference meeting rooms. flexml for the hosted endpoint that runs customizable call flows for numbers. mediator for the hosted endpoint that runs two-stage dialing application. peering_receiver for the hosted endpoint that allows inbound connections but has no application attached to it. peering_sender for the hosted endpoint that allows outbound connections but has no application attached to it. system_gateway for the virtual endpoint that represents the CarrierX switch to the customer. This endpoint is created automatically when a new partner is created and is not modifiable. third_party for a standard SIP endpoint that is configured using IP/port pairs. voicemail for the hosted Voicemail endpoint.
voip_token read only	string	The endpoint authentication token.

Endpoint Address Object

Attribute	Data Type	Description
direction createupdate	string	The direction for the address. Values accepted in this field are: inbound, outbound, and any. The default value for this field is any.
dst_port createupdate	integer	If specified, this entry is only valid for calls that reach CarrierX on this port. CarrierX listens on port 5060-5069, and any of these ports may be specified. The default port value is 5060.
ip createupdate	string	The IP address or fully qualified domain name (FQDN) associated with the endpoint.
location_sid createupdate	string	The location secure ID.
port createupdate	integer	The port. The default port value is 5060.
priority createupdate	integer	The priority of the address. Lower values have higher priority. The default value is 0.
sip_password createupdate	string	For calls sent to this endpoint and if proxy authentication is required, this password and sip_username will be used. This value overrides the out_sip_password value of the Endpoint object.
sip_username createupdate	string	For calls sent to this endpoint and if proxy authentication is required, this username and sip_password will be used. This value overrides the out_sip_username value of the Endpoint object.
srtp createupdate	boolean	Allows the endpoint to receive and send calls that require the use of secure real-time transport protocol (SRTP). Values accepted in this field are: true for the endpoint to accept and send SIP INVITE requests which require the use of SRTP. You should set the transport attribute to tls for this option to work. false for the endpoint to drop SIP INVITE requests that require the use of SRTP, and to send INVITE using unencrypted RTP. The default value is false.
subnet_mask createupdate	integer	The subnet mask associated with the endpoint. The default value for this field is 32. This value cannot be changed unless the endpoint direction is “outbound”. When set, calls can be accepted from any IP address within the range defined by the IP field and the subnet mask field. For outbound endpoints values within the range between 29 and 32 are allowed. To modify this range, please contact technical support at support@carrierx.com.
transport createupdate	string	The protocol for the address. Values accepted in this field are: tcp, tls, and udp. The default value for this field is udp. This field applies to the Third Party endpoint.

Attributes Object

Attribute	Data Type	Description	Applicable Endpoints
account_sid create update	string	The account secure ID.	FlexML, Mediator
api_url create update	string	The URL of the API.	FlexML, Mediator
did_group_id create update	string	The DID group ID.	Conference, FlexML
key create update	string	The attribute key.	Any
subscriber_sid create update	string	The subscriber secure ID.	Conference, FlexML
value create update	string	The attribute value.	Any

Properties Object

Attribute	Data Type	Description	Applicable Endpoints
account_sid read only	string	The account secure ID.	Conference, Conference Playback, FlexML, Mediator, Voicemail
api_url read only	string	The URL of the API.	Conference, Conference Playback, FlexML, Mediator, Voicemail
callback_method create update	string	The callback method used with the Voicemail endpoint. Values accepted in this field are POST and GET. The default value is POST.	Voicemail
callback_url create update	string	The callback URL used with the Voicemail endpoint. The default value is null.	Voicemail
container_sid create update	string	The secure ID of the container where recordings will be stored. The default value is null.	Conference, FlexML, Voicemail
conference_endpoint_sid create update	string	The secure ID of the Conference endpoint associated with the Conference Playback endpoint.	Conference Playback
greeting create update	string	The name of the file used as a greeting for the Voicemail endpoint. The default value is null.	Voicemail
login read only	string	The login for the endpoint.	Conference, Conference Playback, FlexML, Mediator, Voicemail
max_duration create update	number	The maximum length of the recording in seconds used with the Voicemail endpoint.	Voicemail
password read only	string	The password for the endpoint.	Conference, Conference Playback, FlexML, Mediator, Voicemail
subscriber_sid read only	string	The subscriber secure ID.	Conference

Sample Endpoint Object

{
    "addresses": [],
    "attributes": {},
    "capacity": 0,
    "cps_limit": null,
    "endpoint_sid": "358d56f9-1482-4b3d-85a9-efd29afc6ff2",
    "name": "my_conf",
    "out_sip_password": null,
    "out_sip_username": null,
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "properties": {
        "account_sid": "6DcA986G-vcBel19O02iIbYUAawVidvB",
        "api_url": "https://api.carrierx.com/conference/v1",
        "container_sid": "null",
        "login": "sample_conference_775",
        "password": "YnAa9s8ixJKi"
    },
    "transformations": [],
    "type": "conference",
    "voip_token": null
}