NSns-api
Media/Hold Messages/User

Create a new Hold Messge for User from Upload (Multipart/Mixed Post)

Changed on
post/domains/{domain}/users/{user}/msg

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/users/{user}/msg
  • Auth
    HTTP bearer

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000

Request body multipart/form-data

scriptstring

This is a simple explanation of what the audio is and can include what is said in the audio file for explanation.

Filestring binary

This is a "File" type parameter that needs to include the audio file in question using a file post method.

indexinteger

The index of the file, Example "2" for greeting 2.

convertstring

Setting yes will allow the API to attempt to convert the file from accepted formats into the correct format for media playback

synchronousstring required

When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.

Example request

{
  "script": "This is a generic song.",
  "File": "file:///Users/caaker/Downloads/Ding-Dong.wav",
  "index": 2,
  "convert": "yes",
  "synchronous": "yes"
}

Response

object required

Changes

  • bce16087d479Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status