SIP User Group
GetSIPGroupsListApp
GET
https://api.opentact.org/rest/app/group
Get the current user groups list
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
{
"success": true,
"payload": [
{
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {
"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": {},
"account": {},
"created_by": {},
"modified_by": {}
},
"users": [
{}
]
}
]
}
Code Example
curl -X GET "https://api.opentact.org/rest/app/group" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN"
CreateSIPUserGroupApp
POST
https://api.opentact.org/rest/app/group
Create SIP user group
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
Content-Type
string
application/json
Request Body
name
string
[ 3 .. 80 ] characters
users
string
Array of strings List of sip_user_uuid's
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {
"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": {},
"account": {},
"created_by": {},
"modified_by": {}
},
"users": [
{
"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": {},
"account": {},
"created_by": {},
"modified_by": {}
}
]
}
}
Code Example
curl -X POST "https://api.opentact.org/rest/app/group" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"name\":\"string\",\"users\":[\"string\"]}"
ModifySIPUserGroupApp
PATCH
https://api.opentact.org/rest/app/group/{uuid}
Modify SIP user group
Path Parameters
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-HA1B-Token
string
HA1B_TOKEN
Content-Type
string
application/json
Request Body
name
string
[ 3 .. 80 ] characters
users
string
Array of strings List of sip_user_uuid's
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {},
"users": []
}
}
Code Example
curl -X PATCH "https://api.opentact.org/rest/app/group/{uuid}" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"name\":\"string\",\"users\":[\"string\"]}"
RemoveSIPUserGroupApp
DELETE
https://api.opentact.org/rest/app/group/{uuid}
Delete SIP user group
Path Parameters
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-HA1B-Token
string
HA1B_TOKEN
Content-Type
string
application/json
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {},
"users": []
}
}
Code Example
curl -X DELETE "https://api.opentact.org/rest/app/group/{uuid}" \
-H "accept: application/json" \
-H "X-Auth-HA1B-Token: HA1B_TOKEN"
GetSIPUserGroupUsersApp
GET
https://api.opentact.org/rest/app/group/{uuid}/users
Get SIP user group users
Path Parameters
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-HA1B-Token
string
HA1B_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": {},
"account": {},
"created_by": {},
"modified_by": {}
}
]
}
Code Example
curl -X GET "https://api.opentact.org/rest/app/group/{uuid}/users" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN"
AddSIPUsersToSIPUserGroupApp
POST
https://api.opentact.org/rest/app/group/{uuid}/users
Add SIP users to group
Path Parameters
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUserGroup uuid
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
Content-Type
string
application/json
Request Body
users
string
Array of strings SIPUser uuid list
{
"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": {},
"account": {},
"created_by": {},
"modified_by": {}
}
]
}
Code Example
curl -X POST "https://api.opentact.org/rest/app/group/{uuid}/users" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"users\":[\"string\"]}"
AddSIPUsersToSIPUserGroupApp
PATCH
https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}
Add SIP user to group
Path Parameters
sip_user_uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUser uuid
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUserGroup uuid
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {
"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": {},
"account": {},
"created_by": {},
"modified_by": {}
},
"users": [
{
"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": {},
"account": {},
"created_by": {},
"modified_by": {}
}
]
}
}
Code Example
curl -X PATCH "https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN"
RemoveSIPUserFromSIPUserGroupApp
DELETE
https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}
Remove SIP user from SIP User group
Path Parameters
sip_user_uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUser uuid
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUserGroup uuid
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {
"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": {},
"account": {},
"created_by": {},
"modified_by": {}
},
"users": [
{
"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": {},
"account": {},
"created_by": {},
"modified_by": {}
}
]
}
}
Code Example
curl -X DELETE "https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN"
Last updated
Was this helpful?