Update score

This endpoint allows users to create or update their score for a specific campaign. If it is the first attempt of the user, the name parameter can be omited.

put/vocalize/2/scores

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization

Request body

campaignIdstring uuid required

Unique identifier of the campaign the score belongs to.

userIdstring required

User ID, usually in the format of a phone number, e.g., 00387123456.

namestring

Name of the participant e.g. John Smith. Maximum 300 characters long. Cannot be empty or whitespace.

audioUrlstring required

URL of the audio file used for sound matching. Must be a valid URL pointing to an audio file.

languageCodestring required

Language code of the audio file, e.g., 'en-US' for English. This should match the language of the audio file being submitted.

channel'WHATSAPP' | 'RCS' | 'WEB' | 'UNKNOWN'

Channel through which the score is submitted, e.g., 'WHATSAPP', 'WEB', etc.

Example request

{
  "userId": "00387123456",
  "audioUrl": "https://www.example.com/audio/test.wav",
  "languageCode": "en-US"
}

Response

Score successfully created or updated

Example response

{
  "score": {
    "userId": "00387123456",
    "audioUrl": "https://www.example.com/audio/test.wav",
    "languageCode": "en-US"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.