Create a new Greeting from Upload (Multipart/Mixed Post)

post https://{server}/ns-api/v2/domains/{domain}/users/{user}/greetings#3

Note: # and anything after is NOT needed, its just to allow multiple examples for the same path/method.

Path Params

domain

string

required

length ≤ 64

Defaults to ~

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.

user

string

required

length between 0 and 16

Defaults to ~

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.

Body Params

script

string

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

File

file

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

index

integer

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

convert

string

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

synchronous

string

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.

Responses

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://ns-api.com/ns-api/v2/domains/~/users/~/greetings#3' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: multipart/form-data'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Accepted

400Bad Request

401Authentication Required

404Record not found