MOH

Manage your MOH.

Retrieve moh server

get

Retrieve moh server information.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

enabledbooleanOptional

Enable MOH service or not.

play_typestring · enumOptional

Set MOH personalized music by these modes:

• DEFAULT_MUSIC:
• RANDOM_MUSIC_PER_CALL:
• RANDOM_MUSIC_PER_DAY:

Possible values:

4XX

Error

get/moh_server

HTTPcURLJavaScriptPython

GET /api/moh_server HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": true,
  "play_type": "DEFAULT_MUSIC"
}

Update moh server

post

Update moh server

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

enabledbooleanOptional

Enable MOH service or not.

play_typestring · enumOptional

Set MOH personalized music by these modes:

• DEFAULT_MUSIC:
• RANDOM_MUSIC_PER_CALL:
• RANDOM_MUSIC_PER_DAY:

Possible values:

Responses

200

OK

No content

4XX

Error

post/moh_server

HTTPcURLJavaScriptPython

POST /api/moh_server HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "enabled": true,
  "play_type": "DEFAULT_MUSIC"
}

No content

List moh musics

get

Retrieve a collection of moh musics.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get/moh_server/musics

HTTPcURLJavaScriptPython

GET /api/moh_server/musics HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "xxxxxx",
      "file_name": "example",
      "file_size": 100,
      "file_url": ""
    }
  ]
}

Create a MOH music

post

Create a MOH music.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

file_idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

201

Created MOH music

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/moh_server/musics

HTTPcURLJavaScriptPython

POST /api/moh_server/musics HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "file_id": "xxxxxx"
}

{
  "id": "xxxxxxxx"
}

Retrieve a moh music

get

Retrieve a moh music.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

file_namestringOptional

The name of the file.

file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

4XX

Error

get/moh_server/musics/{id}

HTTPcURLJavaScriptPython

GET /api/moh_server/musics/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "file_name": "example",
  "file_size": 100,
  "file_url": ""
}

Delete a MOH music

post

Delete a MOH music

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

4XX

Error

post/moh_server/musics/{id}/destroy

HTTPcURLJavaScriptPython

POST /api/moh_server/musics/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content