Media API

The Media API can be used to query, download and delete media items such as audio files for use with other Nexmo APIs.

Télécharger la spécification OpenAPI

Opérations disponibles

List and search media items

Retrieve the metadata for multiple media items, with the ability to search and paginate.

gethttps://api.nexmo.com/v3/media/

Authentification

Cette API prend en charge l'authentification JWT et l'authentification de base. L'authentification de base est plus facile à mettre en œuvre, mais elle ne prend pas en charge les fonctions avancées telles que les listes de contrôle d'accès.

Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.

Clé	Description	Où	Exemple
Authorization	Votre jeton web JSON. En savoir plus sur les JWT	Headers	`Bearer <JWT>`
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Demande de renseignements Paramètres

order

string

Défautdescending

exempleascending

The order of search results.

Il doit s'agir de l'un d'entre eux :ascendingdescending

page_index

integer

exemple1

Which page to retrieve in pagination

page_size

integer

Défaut20

exemple50

How many items at most per page

start_time

string

Défaut1 week ago

exemple2020-01-01T14:00:00.000Z

Retrieve results created on or after this timestap.

end_time

string

exemple2020-01-01T14:00:00.000Z

Retrieve results created on or before this timestamp.

Réponses
Type de contenu
application/json

Successfully retrieved

page_size

integer

exemple20

The amount of records returned in this response.

page_index

integer

The page_index used in your request.

_links

object

self

object

href

string

exemple/v3/media?page_size=20&account_id=abcd1234&order=descending

first

object

href

string

exemple/v3/media?page_size=20&account_id=abcd1234&order=descending

last

object

href

string

exemple/v3/media?page_size=20&account_id=abcd1234&order=descending

count

integer

exemple1

The total number of records returned by your request.

_embedded

object

A collection of media items. See retrieve a media item for a description of the returned fields

media

array

string

exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

A UUID representing the object.

original_file_name

string

exempletest.wav

The filename of the object as it was originally uploaded.

mime_type

string

exempleaudio/vnd.wave

The IETF MIME type of the file.

account_id

string

exempleabcd1234

The ID of your Nexmo account. This is the same as your API key.

store_id

string

exemples3

An internal identifier of how the file is stored.

max_downloads_allowed

integer

The maximum number of times the file may be downloaded.

times_downloaded

integer

exemple1

The number of times the file has been downloaded.

etag

string

exempleaaaaaaaabbbbccccdddd0123456789ab

An identifier for the content. This will change if the content of the file has been changed (i.e. if you upload a new version of the file). For more information see Wikipedia: HTTP ETag

media_size

integer

exemple1234567

The size of the file in bytes

time_created

string

exemple2020-01-01T14:00:00.000Z

A timestamp for the time that the file was created

time_last_updated

string

exemple2020-01-01T14:00:00.000Z

A timestamp for the time that the file was last modified

public

boolean

Whether the item is available for download without authentication.

metadata_primary

string

A user set string containing metadata about the media file.

metadata_secondary

string

A user set string containing further metadata about the media file.

Exemple Réponse

{
   "page_size": 20,
   "page_index": 0,
   "_links": {
      "self": {
         "href": "/v3/media?page_size=20&account_id=abcd1234&order=descending"
      },
      "first": {
         "href": "/v3/media?page_size=20&account_id=abcd1234&order=descending"
      },
      "last": {
         "href": "/v3/media?page_size=20&account_id=abcd1234&order=descending"
      }
   },
   "count": 1,
   "_embedded": {
      "media": [
         {
            "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
            "original_file_name": "test.wav",
            "mime_type": "audio/vnd.wave",
            "account_id": "abcd1234",
            "store_id": "s3",
            "max_downloads_allowed": 0,
            "times_downloaded": 1,
            "etag": "aaaaaaaabbbbccccdddd0123456789ab",
            "media_size": 1234567,
            "time_created": "2020-01-01T14:00:00.000Z",
            "time_last_updated": "2020-01-01T14:00:00.000Z",
            "public": false,
            "metadata_primary": "string",
            "metadata_secondary": "string"
         }
      ]
   }
}

Retrieve a media item's metadata

Retrieve the metadata for a media item

gethttps://api.nexmo.com/v3/media/:id/info

Authentification

Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.

Clé	Description	Où	Exemple
Authorization	Votre jeton web JSON. En savoir plus sur les JWT	Headers	`Bearer <JWT>`
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Réponses
Type de contenu
application/json

Successfully retrieved

string

exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

A UUID representing the object.

original_file_name

string

exempletest.wav

The filename of the object as it was originally uploaded.

mime_type

string

exempleaudio/vnd.wave

The IETF MIME type of the file.

account_id

string

exempleabcd1234

The ID of your Nexmo account. This is the same as your API key.

store_id

string

exemples3

An internal identifier of how the file is stored.

max_downloads_allowed

integer

The maximum number of times the file may be downloaded.

times_downloaded

integer

exemple1

The number of times the file has been downloaded.

etag

string

exempleaaaaaaaabbbbccccdddd0123456789ab

An identifier for the content. This will change if the content of the file has been changed (i.e. if you upload a new version of the file). For more information see Wikipedia: HTTP ETag

media_size

integer

exemple1234567

The size of the file in bytes

time_created

string

exemple2020-01-01T14:00:00.000Z

A timestamp for the time that the file was created

time_last_updated

string

exemple2020-01-01T14:00:00.000Z

A timestamp for the time that the file was last modified

public

boolean

Whether the item is available for download without authentication.

metadata_primary

string

A user set string containing metadata about the media file.

metadata_secondary

string

A user set string containing further metadata about the media file.

Exemple Réponse

{
   "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "original_file_name": "test.wav",
   "mime_type": "audio/vnd.wave",
   "account_id": "abcd1234",
   "store_id": "s3",
   "max_downloads_allowed": 0,
   "times_downloaded": 1,
   "etag": "aaaaaaaabbbbccccdddd0123456789ab",
   "media_size": 1234567,
   "time_created": "2020-01-01T14:00:00.000Z",
   "time_last_updated": "2020-01-01T14:00:00.000Z",
   "public": false,
   "metadata_primary": "string",
   "metadata_secondary": "string"
}

Update a media item's metadata

Update the metadata of a previously created media item.

puthttps://api.nexmo.com/v3/media/:id/info

Authentification

Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.

Clé	Description	Où	Exemple
Authorization	Votre jeton web JSON. En savoir plus sur les JWT	Headers	`Bearer <JWT>`
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Corps de la demande
Type de contenu
multipart/form-data

public

boolean

exempletrue

Whether the item is publicly available without authentication.

metadata_primary

string

exemplefoo,bar

A string containing metadata about the media file.

metadata_secondary

string

exemple123

A string containing further metadata about the media file.

title

string

exempleVery important recording

A string containing a title for the media file.

description

string

exempleThis is a very important recording. Do not delete.

A description of the media file.

mime_type

string

exempleaudio/vnd.wave

The MIME type of the media file.

max_downloads_allowed

integer

exemple100

The maximum number of times the file may be downloaded. Unlimited when not provided.

Exemple Demande

POST /v3/media/:id/info HTTP/1.1
Host: api.nexmo.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 204

public=true&metadata_primary=foo,bar&metadata_secondary=123&title=Very+important+recording&description=This+is+a+very+important+recording.+Do+not+delete.&mime_type=audio/vnd.wave&max_downloads_allowed=100

POST /v3/media/:id/info HTTP/1.1
Host: api.nexmo.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 204

public=true&metadata_primary=foo,bar&metadata_secondary=123&title=Very+important+recording&description=This+is+a+very+important+recording.+Do+not+delete.&mime_type=audio/vnd.wave&max_downloads_allowed=100

Réponses

Successfully updated

Retrieve a media item's content

Download the file associated with a media item

gethttps://api.nexmo.com/v3/media/:id

Authentification

Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.

Clé	Description	Où	Exemple
Authorization	Votre jeton web JSON. En savoir plus sur les JWT	Headers	`Bearer <JWT>`
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Réponses
Type de contenu
/

Successfully retrieved
The Content-Type header will specify the MIME type of the response body

Exemple Réponse

L'exemple de prévisualisation n'est actuellement pas pris en charge pour le type de contenu : */*

Delete a media item

Delete a previously created media item by ID.

deletehttps://api.nexmo.com/v3/media/:id

Authentification

Vous pouvez utiliser l'authentification JWT ou l'authentification de base, mais pas les deux en même temps.

Clé	Description	Où	Exemple
Authorization	Votre jeton web JSON. En savoir plus sur les JWT	Headers	`Bearer <JWT>`
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Réponses

Successfully deleted

Media API

Opérations disponibles

List and search media items

Authentification

Demande de renseignements Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse

Retrieve a media item's metadata

Authentification

Réponses Type de contenuapplication/json

Exemple Réponse

Update a media item's metadata

Authentification

Corps de la demande Type de contenumultipart/form-data

Exemple Demande

Réponses

Retrieve a media item's content

Authentification

Réponses Type de contenu*/*

Exemple Réponse

Delete a media item

Authentification

Réponses

Réponses
Type de contenu
application/json

Réponses
Type de contenu
application/json

Corps de la demande
Type de contenu
multipart/form-data

Réponses
Type de contenu
/