SIP User Invite
CreateSIPUserInvite
POST
https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites
Create new SIP connection invite
Path Parameters
sip_connection_uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Headers
X.Auth-Token
string
JWT_TOKEN
Content-Type
string
application/json
Request Body
name
string
[ 3 .. 255 ] characters
SIP domain name
expired_on
string
<date-time>
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"expired_on": "2019-08-24T14:15:22Z",
"token": "string",
"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": {}
},
"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": []
},
"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": {}
}
}
}
Code Example
curl -X POST "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites" -H "accept: application/json" -H "X-Auth-Token: JWT_TOKEN" -H "Content-Type: application/json" \
-d "{\"name\":\"string\",\"expired_on\":\"2020-10-29T15:58:21.802Z\"}"
ListSIPUserInvites
GET
https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites
Get SIP connection invites
Path Parameters
sip_connection_uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Headers
X.Auth-Token
string
JWT_TOKEN
{
"success": true,
"payload": [
{
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"expired_on": "2019-08-24T14:15:22Z",
"token": "string",
"sip_connection": {},
"account": {},
"created_by": {},
"modified_by": {}
}
]
}
Code Example
curl -X GET "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites" \
-H "accept: application/json" -H "X-Auth-Token: JWT_TOKEN"
ModifySIPUserInvite
PATCH
https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}
Modify SIP connection invite
Path Parameters
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
sip_connection_uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Headers
X.Auth-Token
string
JWT_TOKEN
Content-Type
string
application/json
Request Body
name
string
[ 3 .. 255 ] characters
SIP domain name
expired_on
string
<date-time>
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"expired_on": "2019-08-24T14:15:22Z",
"token": "string",
"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": {}
},
"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": []
},
"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": {}
}
}
}
Code Example
curl -X PATCH "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}" -H "accept: application/json" -H "X-Auth-Token: JWT_TOKEN" -H "Content-Type: application/json" \
-d "{\"name\":\"string\",\"expired_on\":\"2020-10-29T16:11:25.706Z\"}"
RemoveSIPUserInviteByUUID
DELETE
https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}
Remove SIP user invite
Path Parameters
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
sip_connection_uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Headers
X.Auth-Token
string
JWT_TOKEN
{
"success": true,
"payload": [
{
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"login": "string",
"ha1": "string",
"ha1b": "string",
"remote_ip": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"phone_number": "string",
"avatar": "string",
"dob": "2019-08-24T14:15:22Z",
"gender": "Agender",
"groups": [
{}
],
"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": {}
},
"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": []
},
"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": {}
}
}
]
}
Code Example
curl -X DELETE "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}" -H "accept: application/json" -H "X-Auth-Token: JWT_TOKEN"
Last updated
Was this helpful?