search

Voice Profile

hashtag
CreateOutboundVoiceProfile

POST https://api.opentact.org/rest/profile/outbound_voice

This will create a new outbound voice profile

hashtag
Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

Content-Type

string

application/json

hashtag
Request Body

Name
Type
Description

tech_prefix

integer

<int32> [ 100000 .. 999999 ]

name

string

[ 1 .. 255 ] characters A user-assigned name to help manage the messaging profile.

channel_limit

number

<double> >= 0 Allows you to set a limit for outbound Concurrent Channels (1 call amounts to 1 channel)

max_rate

number

<double> >= 0

record_calls

integer

(EVoiceRecordCallType) Enum: 0 1 2

daily_spend_limit

integer

<float> >= 0

filemat

boolean

(EVoiceRecordCallFileType) Enum: "wav" "mp3"

audio_track_type

boolean

(EVoiceRecordCallAudioTrackType) Enum: 0 1

{
  "success": true,
  "payload": [
    {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "tn": {
        "tn": 0,
        "class4_did_id": 0,
        "registered": true,
        "tnlease": {},
        "profile": {},
        "deleted_on": "2019-08-24T14:15:22Z"
      },
      "account": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "name": "string",
        "email": "string",
        "level": "ServiceAccount",
        "balance": 0,
        "class4_id": 0,
        "deleted_on": "2019-08-24T14:15:22Z",
        "time_zone": {},
        "users": [],
        "admin": {},
        "messaging_profile_default": {},
        "messaging_profiles": [],
        "addresses": []
      },
      "tnorder": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "state": "created",
        "tns": [],
        "account": {},
        "profile": {},
        "sip_connection": {},
        "sip_control_app": {},
        "created_by": {},
        "modified_by": {},
        "request": {},
        "price": {},
        "autorenew": true,
        "tnleases": []
      },
      "expired_on": "2019-08-24T14:15:22Z",
      "autorenew": true,
      "messaging_profile": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "name": "string",
        "callback_url": "string",
        "callback_url2": "string",
        "number_pool_enable": true,
        "long_code_weight": 0,
        "tollfree_weight": 0,
        "skip_unhealthy_tns": true,
        "sticky_sender": true,
        "account": {},
        "created_by": {},
        "modified_by": {},
        "leases": []
      },
      "class4_product_item_id": 0,
      "sip_connection": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "name": "string",
        "is_active": true,
        "tech_prefix": 0,
        "product": {},
        "subdomain": "string",
        "ip": "string",
        "port": 0,
        "class4_ingress_trunk_id": 0,
        "class4_ingress_trunk_settings": {},
        "class4_ingress_resource_ip_id": 0,
        "class4_egress_trunk_id": 0,
        "class4_egress_trunk_settings": {},
        "class4_egress_resource_ip_id": 0,
        "class4_trunk_prefix_id": 0,
        "tnleases": [],
        "sipusers": [],
        "sip_user_invites": [],
        "account": {},
        "created_by": {},
        "modified_by": {},
        "outbound_voice_profile": {}
      },
      "sip_control_app": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "name": "string",
        "is_active": true,
        "subdomain": "string",
        "tnleases": [],
        "class4_egress_trunk_id": 0,
        "class4_egress_trunk_settings": {},
        "class4_egress_resource_ip_id": 0,
        "account": {},
        "created_by": {},
        "modified_by": {},
        "outbound_voice_profile": {}
      },
      "created_by": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "email": "string",
        "password": "string",
        "phone_number": "string",
        "first_name": "string",
        "last_name": "string",
        "avatar": "string",
        "gender": "Agender",
        "dob": "2019-08-24T14:15:22Z",
        "role": "Admin",
        "gmail_user_id": "string",
        "facebook_user_id": "string",
        "apple_user_id": "string",
        "wechat_user_id": "string",
        "deleted_on": "2019-08-24T14:15:22Z",
        "token": "string",
        "account": {}
      },
      "modified_by": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "email": "string",
        "password": "string",
        "phone_number": "string",
        "first_name": "string",
        "last_name": "string",
        "avatar": "string",
        "gender": "Agender",
        "dob": "2019-08-24T14:15:22Z",
        "role": "Admin",
        "gmail_user_id": "string",
        "facebook_user_id": "string",
        "apple_user_id": "string",
        "wechat_user_id": "string",
        "deleted_on": "2019-08-24T14:15:22Z",
        "token": "string",
        "account": {}
      }
    }
  ]
}

hashtag
Code Example

hashtag
ModifyOutboundVoiceProfile

PATCH https://api.opentact.org/rest/profile/outbound_voice

hashtag
Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

Content-Type

string

application/json

hashtag
Request Body

Name
Type
Description

tech_prefix

integer

<int32> [ 100000 .. 999999 ]

name

string

[ 1 .. 255 ] characters A user-assigned name to help manage the messaging profile.

channel_limit

number

<double> >= 0 Allows you to set a limit for outbound Concurrent Channels (1 call amounts to 1 channel)

max_rate

number

<double> >= 0

record_calls

integer

(EVoiceRecordCallType) Enum: 0 1 2

daily_spend_limit

integer

<float> >= 0

filemat

boolean

(EVoiceRecordCallFileType) Enum: "wav" "mp3"

audio_track_type

boolean

(EVoiceRecordCallAudioTrackType) Enum: 0 1

hashtag
Code Example

hashtag
RemoveOutboundVoiceProfileByUUID

DELETE https://api.opentact.org/rest/profile/outbound_voice{uuid}

Get extended messaging profile info

hashtag
Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

hashtag
Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

hashtag
Code Example

hashtag
ListOutboundVoiceProfiles

GET https://api.opentact.org/rest/profile/outbound_voice

This will return a list of voice profiles

hashtag
Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

hashtag
Code Example

hashtag

hashtag
GetOutboundVoiceProfileByUUID

GET https://api.opentact.org/rest/profile/outbound_voice/{uuid}

Get extended voice profile info

hashtag
Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

hashtag
Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

hashtag
Code Example

hashtag
GetOutboundVoiceProfileSIPConnectionsByUUID

GET https://api.opentact.org/rest/profile/outbound_voice/{uuid}/connections/sip

Get SIP connections list linked to Outbound voice profile

hashtag
Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

hashtag
Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

hashtag
Code Example

hashtag

hashtag
GetOutboundVoiceProfileControlAppsByUUID

GET https://api.opentact.org/rest/profile/outbound_voice/{uuid}/connections/sip

Get SIP control apps list linked to Outbound voice profile

hashtag
Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

hashtag
Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

hashtag
Code Example

PreviousMessaging ProfileNextProfile TN info

Last updated