INinfobip
customer-engagement
vocalize
campaign

Create campaign

Create a new campaign with the specified parameters.

post/vocalize/2/campaigns

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

namestring required

Name of the campaign. Must be unique per account.

keywordSpecobject

Specification of language-specific key phrases that users should pronounce during the campaign. This is a dictionary mapping language codes (ISO 639-1 with optional country code, e.g., 'en-US', 'es-ES') to the exact phrases users must say. Find the list of languages supported by Azure <a href="https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt">here</a> and the list of languages supported by Google <a href="https://cloud.google.com/speech-to-text/docs/speech-to-text-supported-languages">here</a>. The speech-to-text engine will compare user audio against these phrases for scoring. If left unspecified, the campaign will rely solely on image and/or audio matching. Phrases should be clear, pronounceable words or short sentences in the target language.

activeFromstring date-time required

Date and time when the campaign becomes active, in ISO 8601 format (e.g., 2023-10-01T00:00:00Z).

activeUntilstring date-time required

Date and time when the campaign ends, in ISO 8601 format (e.g., 2023-10-31T23:59:59Z).

imageUrlstring

Image used for shape matching.

Example request

{
  "name": "My Campaign",
  "keywordSpec": {
    "en-US": "Hello",
    "es-ES": "Hola"
  },
  "imageUrl": "https://www.example.com/image.jpg"
}

Response

Campaign successfully created

namestring required

Name of the campaign. Must be unique per account.

keywordSpecobject

Specification of language-specific key phrases that users should pronounce during the campaign. This is a dictionary mapping language codes (ISO 639-1 with optional country code, e.g., 'en-US', 'es-ES') to the exact phrases users must say. Find the list of languages supported by Azure <a href="https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt">here</a> and the list of languages supported by Google <a href="https://cloud.google.com/speech-to-text/docs/speech-to-text-supported-languages">here</a>. The speech-to-text engine will compare user audio against these phrases for scoring. If left unspecified, the campaign will rely solely on image and/or audio matching. Phrases should be clear, pronounceable words or short sentences in the target language.

activeFromstring date-time required

Date and time when the campaign becomes active, in ISO 8601 format (e.g., 2023-10-01T00:00:00Z).

activeUntilstring date-time required

Date and time when the campaign ends, in ISO 8601 format (e.g., 2023-10-31T23:59:59Z).

imageUrlstring

Image used for shape matching.

idstring uuid required

Unique identifier of the campaign.

accountIdstring required

ID of the account that owns the campaign.

dateCreatedstring date-time

Date and time when the campaign was created, in ISO 8601 format (e.g., 2023-10-01T00:00:00Z).

Example response

{
  "name": "My Campaign",
  "keywordSpec": {
    "en-US": "Hello",
    "es-ES": "Hola"
  },
  "imageUrl": "https://www.example.com/image.jpg"
}

Changes

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