Clients

Clients

A Client represents a user agent that can make and receive calls as well as send and receive text messages using the teleapi Cloud. This means that you can configure any software or hardware VoIP phone with the Client Username and Password in order to register with teleapi Cloud. Once you do that you will be able to do things like:

  • Call or text any teleapi Number to trigger the associated Voice or SMS Application. Notice that you first need to setup the Application with the logic you want and associate it with a teleapi Number. For more information please check here.

  • Call out to any PSTN number.

  • Send SMS to any mobile number.

  • Call or text any other registered Client.

The Client can also be associated with a teleapi Application, either in the form of Visual Designer Application or externally hosted. If that is the case then this application will be called no matter what digits the user of the VoIP phone dials.

SIP Devices should connect to:

server.elasticconnect.com

Client Resource URI

/2012-04-24/Accounts/{AccountSid}/Clients/{ClientSid}
  • Using SIP User Agents. When using teleapi to handle SIP user agent you have to create a new Client resource, this resource acts as an account for your user agent and also dictates how calls made by the user agent should be handled.

  • Client without VoiceUrl teleapi has a new implied behavior when VoiceUrl is not provided for a Client account. teleapi will proxy calls from such Clients to the destination Client (only if registered) or to the destination Application DID.

Only registered Clients are allowed to use the B2BUA/P2P/Proxy functionalities of teleapi . Proxying and P2P calls are only allowed between registered(authenticated) Clients.

The CDR records generated for calls made by Clients, will have account SID the account that the Client belongs to.

Clients Attributes

Attribute

Description

Sid

A string that uniquely identifies this client.

DateCreated

The date that this client was created.

DateUpdated

The date that this client was last updated.

FriendlyName

A friendly name for this client.

AccountSid

The unique id of the Account that owns this client.

ApiVersion

Calls to this client will create a new RCML session with this API version.

Login

The name that is used inside the noun. This is also used by the user agent as the user name used for registration and outbound dialing. This must conform to "userinfo" part as defined in RFC2396.

Password

The password used by the user agent during registration and outbound dialing.

Status

The client status the possible values are 0 for disabled and 1 for enabled.

VoiceUrl

The URL teleapi will request when this client makes an outbound call.

VoiceMethod

The HTTP method teleapi will use when requesting the above Url. Either GET or POST.

VoiceFallbackUrl

The URL that teleapi will request if execution of VoiceUrl fails for any reason.

VoiceFallbackMethod

The HTTP method teleapi will use when requesting the VoiceFallbackUrl. Either GET or POST.

VoiceApplicationSid

If this entry contains an Sid to a voice application then teleapi will ignore these voice URLs and use the voice URLs specified by the voice application.

Uri

The URI for this Client, relative to https://api.teleapi.net/call/2012-04-24/.

Supported Operations

HTTP GET. Returns the representation of an Client resource, including the properties above.

HTTP POST/PUT. Modifies a Client resource and returns the representation, including the properties above. Below you will find a list of optional parameters.

Request Parameters

Parameter

Description

FriendlyName

A formatted version of this client.

Password

The password used by the user agent during registration and outbound dialing.

Status

The client status the possible values are 0 for disabled and 1 for enabled.

VoiceUrl

The URL teleapi will request when this client receives a call.

VoiceMethod

The HTTP method teleapi will use when requesting the above Url. Either GET or POST.

VoiceFallbackUrl

The URL that teleapi will request if execution of VoiceUrl fails for any reason.

VoiceApplicationSid

If this entry contains an Sid to a voice application then teleapi will ignore these voice URLs and use the voice URLs specified by the voice application.

HTTP DELETE

Deletes a Client from the user’s Account.

Client List Resource

Client List Resource URI.

/2012-04-24/Accounts/{AccountSid}/Clients

Supported Operations

HTTP GET. Returns the list representation of all the Client resources for this Account, including the properties above. HTTP POST. Creates a new Client and returns the representation of the resource, including the properties above. Below you will find a list of required and optional parameters.

Request Parameters

Parameter

Description

FriendlyName

FriendlyName

Login

The name that is used inside the noun. This is also used by the user agent as the user name used for registration and outbound dialing.

Password

The password used by the user agent during registration and outbound dialing.

Status

The client status the possible values are 0 for disabled and 1 for enabled.

VoiceUrl

The URL teleapi will request when this client makes an outbound call.

VoiceMethod

The HTTP method teleapi will use when requesting the above Url. Either GET or POST.

VoiceFallbackUrl

The URL that teleapi will request if execution of VoiceUrl fails for any reason.

VoiceFallbackMethod

The HTTP method teleapi will use when requesting the VoiceFallbackUrl. Either GET or POST.

VoiceApplicationSid

If this entry contains an Sid to a voice application then teleapi will ignore these voice URLs and use the voice URLs specified by the voice application.