Gomobile Dev Hub

https://docs.gomobile.ma
Admin
Gomobile Dev Hub provides guides and API documentation for launching omnichannel, voice-first...
Tokens:177,550
Snippets:821
Trust Score:6.2
Update:9 months ago
Show doc for...
Tokens:
Raw
### POST /programs/:id/launch

Source: https://docs.gomobile.ma/help-center/faq

Launches a program that has been configured and is ready to start executions. Ensures all prerequisites like future start times and active status are met.

```APIDOC
## POST /programs/:id/launch

### Description
Launches a program, initiating call executions based on its configuration. This endpoint is used to start a program that is in an `active` state and has a valid future `startAt` time.

### Method
POST

### Endpoint
`/programs/:id/launch`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the program to launch.

### Request Body
*Note: This endpoint does not typically require a request body, but the program's status and configuration are crucial for successful launch.*

### Request Example
```json
{
  "message": "Launching program ID: 12345"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the launch operation.
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "Program 12345 launched successfully."
}
```
```

--------------------------------

### Set Gomobile Environment Variables

Source: https://docs.gomobile.ma/documentation/getting-started/installation

These commands set the Gomobile API URL and API key as environment variables. It's recommended to add these to your shell's configuration file (.bashrc, .zshrc, etc.) for persistent access. Replace 'your-api-key' with your actual key.

```bash
# Add to your .bashrc, .zshrc, or equivalent
export GOMOBILE_API_URL="https://api.gomobile.io"
export GOMOBILE_API_KEY="your-api-key"
```

--------------------------------

### Program Creation

Source: https://docs.gomobile.ma/help-center/faq

Create a new program, optionally scheduling its start and end times.

```APIDOC
## POST /programs

### Description
Creates a new program for managing call campaigns. You can specify scheduled start and end times for the program.

### Method
POST

### Endpoint
`/programs`

### Parameters
#### Request Body
- **name** (string) - Required - The name of the program.
- **startAt** (string) - Optional - ISO 8601 timestamp indicating when the program should begin. If not provided, the program starts immediately.
- **stopAt** (string) - Optional - ISO 8601 timestamp indicating when the program should end.

### Request Example
```json
{
  "name": "Morning Campaign",
  "startAt": "2025-12-20T09:00:00Z",
  "stopAt": "2025-12-20T18:00:00Z"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created program.
- **name** (string) - The name of the program.
- **startAt** (string) - The scheduled start time.
- **stopAt** (string) - The scheduled end time.
```

--------------------------------

### GET /programs

Source: https://docs.gomobile.ma/api-reference/programs

Retrieves a list of all programs associated with the account. This endpoint is useful for getting an overview of active and inactive campaigns.

```APIDOC
## GET /programs

### Description
List programs associated with the account.

### Method
GET

### Endpoint
/programs

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **programs** (array) - A list of program objects. Each program object contains details such as id, name, organizationId, audienceId, flowId, status, startAt, stopAt, didPool, retryStrategy, pauseWindows, createdAt, and updatedAt.

#### Response Example
```json
[
  {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "name": "Summer Sale Campaign",
    "organizationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "audienceId": "b2c3d4e5-f6a7-8901-2345-67890abcdef0",
    "flowId": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
    "status": "active",
    "startAt": "2023-10-26T10:00:00Z",
    "stopAt": null,
    "didPool": [
      "+15551234567",
      "+15557654321"
    ],
    "retryStrategy": {
      "type": "fixed_delay",
      "delayMinutes": 60,
      "maxRetries": 3
    },
    "pauseWindows": {
      "sunday": [
        {
          "startAt": {"hour": 22, "minute": 0},
          "endAt": {"hour": 8, "minute": 0}
        }
      ]
    },
    "createdAt": "2023-10-25T09:00:00Z",
    "updatedAt": "2023-10-25T09:30:00Z"
  }
]
```
```

--------------------------------

### GET /program-executions/{EXECUTION_ID}

Source: https://docs.gomobile.ma/documentation/guides/building-your-first-campaign

Retrieves the current status and progress of a specific campaign execution.

```APIDOC
## GET /program-executions/{EXECUTION_ID}

### Description
Retrieves the current status and progress of a specific campaign execution using its unique ID.

### Method
GET

### Endpoint
/program-executions/EXECUTION_ID

### Parameters
#### Path Parameters
- **EXECUTION_ID** (string) - Required - The unique identifier of the program execution to monitor.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET https://api.gomobile.io/program-executions/EXECUTION_ID \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the execution (e.g., 'running', 'completed').
- **totalContacts** (integer) - The total number of contacts targeted by the campaign.
- **contactsCompleted** (integer) - The number of contacts for whom the campaign has successfully completed.
- **contactsFailed** (integer) - The number of contacts for whom the campaign has failed.
- **contactsPending** (integer) - The number of contacts awaiting processing.
- **contactsInProgress** (integer) - The number of contacts currently being processed.

#### Response Example
```json
{
  "status": "running",
  "totalContacts": 3,
  "contactsCompleted": 1,
  "contactsFailed": 0,
  "contactsPending": 1,
  "contactsInProgress": 1
}
```
```

--------------------------------

### List All Dictionaries (Bash)

Source: https://docs.gomobile.ma/documentation/features/dictionaries

This command retrieves a list of all available dictionaries, including both system-provided and custom dictionaries. It requires your API key for authentication.

```bash
curl -X GET https://api.gomobile.io/dictionaries \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### POST /programs/{PROGRAM_ID}/launch

Source: https://docs.gomobile.ma/documentation/guides/building-your-first-campaign

Launches a specific campaign program by its ID. This initiates the campaign execution.

```APIDOC
## POST /programs/{PROGRAM_ID}/launch

### Description
Launches a campaign program by its ID. This initiates the campaign execution.

### Method
POST

### Endpoint
/programs/PROGRAM_ID/launch

### Parameters
#### Path Parameters
- **PROGRAM_ID** (string) - Required - The unique identifier of the program to launch.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X POST https://api.gomobile.io/programs/PROGRAM_ID/launch \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **executionId** (string) - The unique identifier for the initiated program execution.

#### Response Example
```json
{
  "executionId": "execution-uuid"
}
```
```

--------------------------------

### Verify Setup - Get User Profile

Source: https://docs.gomobile.ma/documentation/getting-started/installation

Verify your API setup by fetching your user profile. This endpoint requires your API key for authentication.

```APIDOC
## GET /users/me

### Description
Fetches the authenticated user's profile information, including organization details.

### Method
GET

### Endpoint
/users/me

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET https://api.gomobile.io/users/me \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **user_id** (string) - The unique identifier for the user.
- **username** (string) - The user's username.
- **email** (string) - The user's email address.
- **organization_id** (string) - The identifier for the user's organization.

#### Response Example
```json
{
  "user_id": "user_abc123",
  "username": "johndoe",
  "email": "john.doe@example.com",
  "organization_id": "org_xyz789"
}
```
```

--------------------------------

### Making an Authenticated GET Request with cURL

Source: https://docs.gomobile.ma/documentation/getting-started/authentication

Example using cURL to make an authenticated GET request to the Gomobile API. It shows how to set the `Authorization` header with a bearer token. This requires a valid API key.

```bash
curl -X GET https://api.gomobile.io/users/me \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Launch Program Execution API

Source: https://docs.gomobile.ma/documentation/getting-started/making-your-first-call

This endpoint initiates the execution of a previously created program.

```APIDOC
## POST /programs/{PROGRAM_ID}/launch

### Description
Launches an execution for a specified program.

### Method
POST

### Endpoint
https://api.gomobile.io/programs/PROGRAM_ID/launch

### Parameters
#### Path Parameters
- **PROGRAM_ID** (string) - Required - The ID of the program to launch.

### Request Example
(No request body needed for this endpoint)

### Response
#### Success Response (200)
- **executionId** (string) - The unique identifier for the program execution.

#### Response Example
```json
{
  "executionId": "execution-uuid-here"
}
```
```

--------------------------------

### Get Dictionary Entry

Source: https://docs.gomobile.ma/documentation/features/dictionaries

Retrieves details for a specific entry within a dictionary, including its associated audio file ID.

```APIDOC
## GET /dictionaries/{DICTIONARY_ID}/entries/{KEY}

### Description
Retrieves details for a specific entry within a dictionary.

### Method
GET

### Endpoint
`/dictionaries/{DICTIONARY_ID}/entries/{KEY}`

### Parameters
#### Path Parameters
- **DICTIONARY_ID** (string) - Required - The ID of the dictionary.
- **KEY** (string) - Required - The key of the entry to retrieve.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
```bash
curl -X GET https://api.gomobile.io/dictionaries/DICTIONARY_ID/entries/dirham \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200 OK)
- **id** (string) - The unique identifier for the entry.
- **dictionaryId** (string) - The ID of the dictionary the entry belongs to.
- **key** (string) - The key associated with the entry.
- **audioId** (string) - The ID of the audio file for this entry.
- **createdAt** (string) - The timestamp when the entry was created.

#### Response Example
```json
{
  "id": "entry-uuid",
  "dictionaryId": "dictionary-uuid",
  "key": "dirham",
  "audioId": "audio-uuid",
  "createdAt": "2025-01-15T10:30:00.000Z"
}
```
```

--------------------------------

### Get Specific Dictionary Entry (Bash)

Source: https://docs.gomobile.ma/documentation/features/dictionaries

This command retrieves details about a specific entry within a dictionary, identified by the dictionary ID and the entry's key. It requires your API key for authentication.

```bash
curl -X GET https://api.gomobile.io/dictionaries/DICTIONARY_ID/entries/dirham \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Create Gomobile.io Program using cURL

Source: https://docs.gomobile.ma/documentation/guides/building-your-first-campaign

This snippet shows how to create a program (campaign) using the Gomobile.io API. It links a previously created flow, specifies an audience, sets start and stop times, defines a DID pool for outgoing calls, and configures retry strategies and pause windows. This requires an API key and the ID of the created flow.

```bash
curl -X POST https://api.gomobile.io/programs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "name": "January Payment Reminders", \
    "audienceId": "AUDIENCE_ID", \
    "flowId": "FLOW_ID", \
    "startAt": "2025-01-20T09:00:00Z", \
    "stopAt": "2025-01-20T18:00:00Z", \
    "didPool": ["+212500000001"], \
    "retryStrategy": { \
      "type": "fixed_delay", \
      "delayMinutes": 30, \
      "maxRetries": 1 \
    }, \
    "pauseWindows": { \
      "monday": [ \
        { "startAt": { "hour": 12, "minute": 0 }, "endAt": { "hour": 14, "minute": 0 } } \
      ] \
    } \
  }'
```

--------------------------------

### POST /audio-management/upload

Source: https://docs.gomobile.ma/documentation/guides/building-your-first-campaign

Uploads an audio file for use in campaigns.

```APIDOC
## POST /audio-management/upload

### Description
Uploads an audio file for use in campaigns.

### Method
POST

### Endpoint
/audio-management/upload

### Parameters
#### Request Body
- **file** (file) - Required - The audio file to upload (e.g., .wav).
- **title** (string) - Required - A title for the audio file.
- **usageType** (string) - Required - The intended use of the audio file (e.g., 'welcome', 'prompt', 'notification').

### Request Example
```bash
curl -X POST https://api.gomobile.io/audio-management/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@welcome.wav" \
  -F "title=Payment Reminder Welcome" \
  -F "usageType=welcome"
```

### Response
#### Success Response (200)
- **audioId** (string) - The ID of the uploaded audio file.

#### Response Example
```json
{
  "audioId": "some_audio_id"
}
```
```

--------------------------------

### Create a Program for Call Campaigns using Gomobile API

Source: https://docs.gomobile.ma/documentation/getting-started/making-your-first-call

This snippet shows how to create a program in Gomobile, which orchestrates call campaigns. It links an audience and a flow, defines a start time, and specifies calling numbers (DID pool) and retry strategy. Authentication with an API key is necessary.

```bash
curl -X POST https://api.gomobile.io/programs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "name": "My First Campaign", \
    "audienceId": "AUDIENCE_ID", \
    "flowId": "FLOW_ID", \
    "startAt": "2025-01-20T10:00:00Z", \
    "didPool": ["+212500000001"], \
    "retryStrategy": { \
      "type": "none" \
    } \
  }'
```

--------------------------------

### Example API Request Body - JavaScript

Source: https://docs.gomobile.ma/index

This JSON object represents a typical request body for initiating an API call within the Gomobile platform. It includes essential parameters such as the originating number, contact identifier, flow identifier, retry scheduling, and the start time for the operation. This structure is crucial for configuring and executing voice-first communication flows.

```javascript
{
    "fromNumber": "05*********",
    "contactId": "YOUR_CONTACT_ID",
    "flowId": "FLOW_ID",
    "retry": {
      "type": "scheduled",
      "dates": [
        "2025-12-16T11:15:30Z",
        "2025-12-16T11:15:40Z"
      ]
    },
    "startAt": "2025-12-16T11:15:00Z"
}
```

--------------------------------

### Place Voice Call Example

Source: https://docs.gomobile.ma/index

Example of a request body for placing a voice call using the Gomobile API.

```APIDOC
## Place Voice Call Request Body

### Description
This is an example of the JSON payload required to initiate a voice call.

### Method
POST

### Endpoint
/v1/calls

### Request Body
- **fromNumber** (string) - Required - The phone number to display as the caller ID.
- **contactId** (string) - Required - The identifier for the contact to call.
- **flowId** (string) - Required - The identifier for the call flow to execute.
- **retry** (object) - Optional - Configuration for call retries.
  - **type** (string) - Required - The type of retry ('scheduled').
  - **dates** (array of strings) - Required - A list of ISO 8601 formatted dates for scheduled retries.
- **startAt** (string) - Optional - ISO 8601 formatted timestamp for when the call should start.

### Request Example
```json
{
    "fromNumber": "05*********",
    "contactId": "YOUR_CONTACT_ID",
    "flowId": "FLOW_ID",
    "retry": {
      "type": "scheduled",
      "dates": [
        "2025-12-16T11:15:30Z",
        "2025-12-16T11:15:40Z"
      ]
    },
    "startAt": "2025-12-16T11:15:00Z"
}
```

### Response
#### Success Response (200)
- **callId** (string) - The unique identifier for the initiated call.
- **status** (string) - The current status of the call.

#### Response Example
```json
{
  "callId": "generated_call_id",
  "status": "initiated"
}
```
```

--------------------------------

### POST /contact

Source: https://docs.gomobile.ma/documentation/guides/building-your-first-campaign

Creates a new contact with their details and custom attributes.

```APIDOC
## POST /contact

### Description
Creates a new contact with their details and custom attributes.

### Method
POST

### Endpoint
/contact

### Parameters
#### Request Body
- **firstName** (string) - Required - The first name of the contact.
- **lastName** (string) - Required - The last name of the contact.
- **primaryPhone** (string) - Required - The primary phone number of the contact.
- **customAttributes** (object) - Optional - A key-value pair object for custom contact attributes.

### Request Example
```json
{
  "firstName": "Ahmed",
  "lastName": "Tazi",
  "primaryPhone": "+212612345678",
  "customAttributes": {
    "account_balance": 1500,
    "days_overdue": 15
  }
}
```

### Response
#### Success Response (200)
- **contactId** (string) - The ID of the newly created contact.

#### Response Example
```json
{
  "contactId": "some_contact_id"
}
```
```

--------------------------------

### Upload Audio Files with API

Source: https://docs.gomobile.ma/documentation/guides/building-your-first-campaign

Uploads audio files to be used in your calling campaigns. This API endpoint requires the audio file, a title, and a usage type (e.g., 'welcome', 'prompt', 'notification'). Multiple calls are needed for different audio assets.

```bash
# Welcome message
curl -X POST https://api.gomobile.io/audio-management/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@welcome.wav" \
  -F "title=Payment Reminder Welcome" \
  -F "usageType=welcome"

# Your balance is... (before the number)
curl -X POST https://api.gomobile.io/audio-management/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@your-balance-is.wav" \
  -F "title=Your Balance Is" \
  -F "usageType=prompt"

# Dirhams (currency)
curl -X POST https://api.gomobile.io/audio-management/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@dirhams.wav" \
  -F "title=Dirhams" \
  -F "usageType=prompt"

# Menu prompt
curl -X POST https://api.gomobile.io/audio-management/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@menu-prompt.wav" \
  -F "title=Menu Prompt" \
  -F "usageType=prompt"

# Confirmation message
curl -X POST https://api.gomobile.io/audio-management/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@confirmation.wav" \
  -F "title=Confirmation" \
  -F "usageType=notification"

# Callback message
curl -X POST https://api.gomobile.io/audio-management/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@callback-scheduled.wav" \
  -F "title=Callback Scheduled" \
  -F "usageType=notification"
```

--------------------------------

### GET /audio-management/audio/{AUDIO_ID}/metadata - Get Audio Metadata

Source: https://docs.gomobile.ma/documentation/features/audio-management

Retrieves detailed metadata for a specific audio file using its unique ID.

```APIDOC
## GET /audio-management/audio/{AUDIO_ID}/metadata

### Description
Fetches the metadata for a specific audio file identified by its unique ID.

### Method
GET

### Endpoint
https://api.gomobile.io/audio-management/audio/{AUDIO_ID}/metadata

### Parameters
#### Path Parameters
- **AUDIO_ID** (string) - Required - The unique identifier of the audio file.

### Request Example
```bash
curl -X GET https://api.gomobile.io/audio-management/audio/AUDIO_ID/metadata \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200)
Returns the full metadata object for the specified audio file, similar to the response of the upload endpoint.

#### Response Example
```json
{
  "id": "audio-uuid",
  "title": "Welcome Message",
  "description": "Main greeting for payment campaigns",
  "usageType": "welcome",
  "tags": ["greeting", "payment"],
  "durationSeconds": 8.5,
  "sampleRate": 8000,
  "channels": 1,
  "bitDepth": 16,
  "originalFileName": "audio.wav",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "file": {
    "id": "file-uuid",
    "name": "audio_processed.wav",
    "contentType": "audio/wav",
    "fileSize": 136000
  }
}
```
```

--------------------------------

### Create Program

Source: https://docs.gomobile.ma/documentation/guides/building-your-first-campaign

This endpoint allows you to create a new program (campaign) that utilizes a call flow to engage with an audience.

```APIDOC
## POST /programs

### Description
Creates a new program (campaign) that uses a specific call flow to reach an audience at scheduled times, with defined retry strategies and pause windows.

### Method
POST

### Endpoint
https://api.gomobile.io/programs

### Parameters
#### Request Body
- **name** (string) - Required - The name of the program.
- **audienceId** (string) - Required - The ID of the audience to target.
- **flowId** (string) - Required - The ID of the call flow to use for this program.
- **startAt** (string) - Required - ISO 8601 timestamp for when the program should start.
- **stopAt** (string) - Required - ISO 8601 timestamp for when the program should stop.
- **didPool** (array of strings) - Required - An array of phone numbers (DIDs) to use for making calls.
- **retryStrategy** (object) - Optional - Defines how to retry calls.
  - **type** (string) - Required - The type of retry strategy (e.g., 'fixed_delay').
  - **delayMinutes** (integer) - Required if type is 'fixed_delay' - The delay in minutes between retries.
  - **maxRetries** (integer) - Required - The maximum number of retries.
- **pauseWindows** (object) - Optional - Defines periods when calls should not be made.
  - **monday** (array of objects) - Optional - Pause windows for Monday.
    - **startAt** (object) - Required - Start time of the pause window.
      - **hour** (integer) - Required - Hour (0-23).
      - **minute** (integer) - Required - Minute (0-59).
    - **endAt** (object) - Required - End time of the pause window.
      - **hour** (integer) - Required - Hour (0-23).
      - **minute** (integer) - Required - Minute (0-59).
  - (Similar objects for Tuesday to Sunday)

### Request Example
```json
{
  "name": "January Payment Reminders",
  "audienceId": "AUDIENCE_ID",
  "flowId": "FLOW_ID",
  "startAt": "2025-01-20T09:00:00Z",
  "stopAt": "2025-01-20T18:00:00Z",
  "didPool": ["+212500000001"],
  "retryStrategy": {
    "type": "fixed_delay",
    "delayMinutes": 30,
    "maxRetries": 1
  },
  "pauseWindows": {
    "monday": [
      { "startAt": { "hour": 12, "minute": 0 }, "endAt": { "hour": 14, "minute": 0 } }
    ]
  }
}
```

### Response
#### Success Response (200)
- **programId** (string) - The ID of the created program.

#### Response Example
```json
{
  "programId": "PROGRAM_ID_EXAMPLE"
}
```
```

--------------------------------

### POST /audience

Source: https://docs.gomobile.ma/documentation/guides/building-your-first-campaign

Creates a new audience to group contacts.

```APIDOC
## POST /audience

### Description
Creates a new audience to group contacts.

### Method
POST

### Endpoint
/audience

### Parameters
#### Request Body
- **name** (string) - Required - The name of the audience.
- **description** (string) - Optional - A description for the audience.

### Request Example
```json
{
  "name": "January Payment Reminders",
  "description": "Customers with outstanding balances for January campaign"
}
```

### Response
#### Success Response (200)
- **audienceId** (string) - The ID of the newly created audience.

#### Response Example
```json
{
  "audienceId": "some_audience_id"
}
```
```

--------------------------------

### GET /dictionaries

Source: https://docs.gomobile.ma/api-reference/dictionaries

Retrieves a list of available sound dictionaries.

```APIDOC
## GET /dictionaries

### Description
Lists available sound dictionaries.

### Method
GET

### Endpoint
/dictionaries

### Parameters

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **Array of Dictionary objects**: Contains details for each dictionary.

#### Response Example
```json
[
  {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "name": "Gomobile Arabic Dictionary",
    "description": "Standard Arabic dictionary for Gomobile.",
    "language": "ar",
    "organizationId": null,
    "isSystem": true,
    "createdAt": "2023-10-27T10:00:00Z",
    "updatedAt": "2023-10-27T10:00:00Z"
  }
]
```
```

--------------------------------

### Create a Program API

Source: https://docs.gomobile.ma/documentation/getting-started/making-your-first-call

This endpoint creates a program that ties together an audience, a flow, and a schedule for making calls. Save the returned program ID.

```APIDOC
## POST /programs

### Description
Creates a program to manage a call campaign, linking an audience, flow, and schedule.

### Method
POST

### Endpoint
https://api.gomobile.io/programs

### Parameters
#### Request Body
- **name** (string) - Required - The name of the program.
- **audienceId** (string) - Required - The ID of the audience to be called.
- **flowId** (string) - Required - The ID of the flow to be used for the calls.
- **startAt** (string) - Required - The date and time when the program should start executing (ISO 8601 format).
- **didPool** (array of strings) - Required - A list of phone numbers to be used as caller ID.
- **retryStrategy** (object) - Optional - Defines the retry mechanism for failed calls.
  - **type** (string) - Required - The type of retry strategy (e.g., 'none').

### Request Example
```json
{
  "name": "My First Campaign",
  "audienceId": "AUDIENCE_ID",
  "flowId": "FLOW_ID",
  "startAt": "2025-01-20T10:00:00Z",
  "didPool": ["+212500000001"],
  "retryStrategy": {
    "type": "none"
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created program.
- **name** (string) - The name of the program.
- **audienceId** (string) - The ID of the associated audience.
- **flowId** (string) - The ID of the associated flow.
- **startAt** (string) - The scheduled start time.
- **createdAt** (string) - The timestamp when the program was created.

#### Response Example
```json
{
  "id": "program-uuid-here",
  "name": "My First Campaign",
  "audienceId": "AUDIENCE_ID",
  "flowId": "FLOW_ID",
  "startAt": "2025-01-20T10:00:00Z",
  "createdAt": "2025-01-15T10:45:00.000Z"
}
```
```

--------------------------------

### Remove Dictionary Entry

Source: https://docs.gomobile.ma/documentation/features/dictionaries

Deletes a specific entry from a dictionary.

```APIDOC
## DELETE /dictionaries/{DICTIONARY_ID}/entries/{KEY}

### Description
Deletes a specific entry from a dictionary.

### Method
DELETE

### Endpoint
`/dictionaries/{DICTIONARY_ID}/entries/{KEY}`

### Parameters
#### Path Parameters
- **DICTIONARY_ID** (string) - Required - The ID of the dictionary.
- **KEY** (string) - Required - The key of the entry to delete.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
```bash
curl -X DELETE https://api.gomobile.io/dictionaries/DICTIONARY_ID/entries/dirham \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (204 No Content)
Indicates the entry was successfully deleted.
```

--------------------------------

### GET /dictionaries/{dictionaryId}

Source: https://docs.gomobile.ma/api-reference/dictionaries

Retrieves the details of a specific sound dictionary by its ID.

```APIDOC
## GET /dictionaries/{dictionaryId}

### Description
Retrieves the details of a specific sound dictionary by its ID.

### Method
GET

### Endpoint
/dictionaries/{dictionaryId}

### Parameters
#### Path Parameters
- **dictionaryId** (string) - Required - The unique identifier of the dictionary.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the dictionary.
- **name** (string) - The name of the dictionary.
- **description** (string) - An optional description of the dictionary.
- **language** (SoundLanguage) - The language of the dictionary (e.g., 'ar', 'fr').
- **organizationId** (string) - The organization identifier associated with the dictionary.
- **isSystem** (boolean) - Indicates if the dictionary is a system dictionary.
- **createdAt** (string) - The timestamp when the dictionary was created.
- **updatedAt** (string) - The timestamp when the dictionary was last updated.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "Greeting Sounds",
  "description": "Common greeting phrases",
  "language": "en",
  "organizationId": "f0e9d8c7-b6a5-4321-0987-654321fedcba",
  "isSystem": false,
  "createdAt": "2023-10-27T10:00:00Z",
  "updatedAt": "2023-10-27T10:00:00Z"
}
```

#### Error Responses
- **401**: Unauthorized
- **404**: Dictionary not found
```

--------------------------------

### Using Environment Variables for API Key with cURL

Source: https://docs.gomobile.ma/documentation/getting-started/authentication

This example demonstrates how to securely use an API key stored in an environment variable for cURL requests. It involves exporting the key and then referencing it in the `Authorization` header.

```bash
# Store your key as an environment variable
export GOMOBILE_API_KEY="your-api-key"

# Use it in scripts
curl -X GET https://api.gomobile.io/users/me \
  -H "Authorization: Bearer $GOMOBILE_API_KEY"
```

--------------------------------

### Delete Custom Dictionary

Source: https://docs.gomobile.ma/documentation/features/dictionaries

Removes a custom dictionary. System dictionaries cannot be deleted.

```APIDOC
## DELETE /dictionaries/{DICTIONARY_ID}

### Description
Deletes a custom dictionary. System dictionaries cannot be deleted.

### Method
DELETE

### Endpoint
`/dictionaries/{DICTIONARY_ID}`

### Parameters
#### Path Parameters
- **DICTIONARY_ID** (string) - Required - The ID of the custom dictionary to delete.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
```bash
curl -X DELETE https://api.gomobile.io/dictionaries/DICTIONARY_ID \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (204 No Content)
Indicates the dictionary was successfully deleted.
```

--------------------------------

### Schedule Program Start Time

Source: https://docs.gomobile.ma/help-center/faq

Allows for scheduling the initiation of a calling campaign. The `startAt` field specifies the exact ISO 8601 timestamp when the program should begin making calls. An optional `stopAt` field can also be set to define an end time for the campaign.

```json
{
  "name": "Morning Campaign",
  "startAt": "2025-12-20T09:00:00Z",
  "stopAt": "2025-12-20T18:00:00Z",  // optional end time
  ...
}
```

--------------------------------

### GET /flows/{flowId}

Source: https://docs.gomobile.ma/api-reference/flows

Retrieves a specific flow definition by its unique identifier.

```APIDOC
## GET /flows/{flowId}

### Description
Retrieves a specific flow definition by its unique identifier.

### Method
GET

### Endpoint
/flows/{flowId}

### Parameters
#### Path Parameters
- **flowId** (string) - Required - The unique identifier of the flow to retrieve.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the flow.
- **organizationId** (string) - The UUID of the organization the flow belongs to.
- **name** (string) - The name of the flow.
- **description** (string) - A description of the flow.
- **version** (integer) - The version of the flow.
- **metadata** (object) - Metadata associated with the flow (e.g., tags, category, author).
- **graph** (object) - The flow's graphical structure, including nodes and the start node.
- **variableSchema** (object) - Defines the schema for variables used within the flow.
- **createdAt** (string) - The timestamp when the flow was created.
- **updatedAt** (string) - The timestamp when the flow was last updated.

#### Response Example
```json
{
  "id": "flow_123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "org_123e4567-e89b-12d3-a456-426614174001",
  "name": "Welcome Call",
  "description": "A simple welcome flow.",
  "version": 1,
  "metadata": {
    "tags": ["onboarding", "welcome"],
    "category": "customer service",
    "author": "Jane Doe",
    "version": "1.0"
  },
  "graph": {
    "nodes": [
      {
        "id": "start",
        "type": "answer",
        "label": "Start",
        "config": {},
        "outputs": {}
      }
    ],
    "startNodeId": "start"
  },
  "variableSchema": {},
  "createdAt": "2023-10-27T10:00:00Z",
  "updatedAt": "2023-10-27T10:00:00Z"
}
```

#### Error Responses
- **401** - Unauthorized
- **404** - Flow not found
```

--------------------------------

### Create Gomobile Program using cURL

Source: https://docs.gomobile.ma/documentation/core-concepts/programs

This snippet demonstrates how to create a new program using a cURL command. It includes specifying campaign details like name, audience, flow, schedule, DID pool, retry strategy, and pause windows. The API endpoint is `https://api.gomobile.io/programs` and it expects a POST request with a JSON payload.

```bash
curl -X POST https://api.gomobile.io/programs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "name": "January Payment Reminders", \
    "audienceId": "audience-uuid", \
    "flowId": "flow-uuid", \
    "startAt": "2025-01-20T09:00:00Z", \
    "stopAt": "2025-01-20T18:00:00Z", \
    "didPool": ["+212500000001", "+212500000002"], \
    "retryStrategy": { \
      "type": "fixed_delay", \
      "delayMinutes": 60, \
      "maxRetries": 2 \
    }, \
    "pauseWindows": { \
      "monday": [ \
        { "startAt": { "hour": 12, "minute": 0 }, "endAt": { "hour": 14, "minute": 0 } } \
      ], \
      "tuesday": [ \
        { "startAt": { "hour": 12, "minute": 0 }, "endAt": { "hour": 14, "minute": 0 } } \
      ] \
    } \
  }'
```

--------------------------------

### POST /programs

Source: https://docs.gomobile.ma/api-reference/programs

Creates a new calling campaign program. Requires authentication with a Bearer token.

```APIDOC
## POST /programs

### Description
Create a new calling campaign program.

### Method
POST

### Endpoint
/programs

### Parameters
#### Request Body
- **name** (string) - Required - The name of the program.
- **audienceId** (string, format: uuid) - Required - The ID of the audience for the program.
- **flowId** (string, format: uuid) - Required - The ID of the flow for the program.
- **startAt** (string, format: date-time) - Required - The start date and time for the program.
- **stopAt** (string, format: date-time) - Optional - The stop date and time for the program.
- **didPool** (array of strings) - Required - A list of phone numbers to be used for calling.
- **retryStrategy** (object) - Required - The retry strategy for failed calls.
  - **type** (string, enum: ['none', 'fixed_delay', 'scheduled']) - Required - The type of retry strategy.
  - **delayMinutes** (integer) - Required if type is 'fixed_delay' - The delay in minutes before retrying.
  - **maxRetries** (integer) - Required if type is 'fixed_delay' - The maximum number of retries.
  - **retryDates** (array of strings, format: date-time) - Required if type is 'scheduled' - The dates on which to retry.
- **pauseWindows** (object) - Optional - Defines windows during which calls should not be made.
  - **sunday** (array of objects) - Optional - Pause windows for Sunday.
  - **monday** (array of objects) - Optional - Pause windows for Monday.
  - **tuesday** (array of objects) - Optional - Pause windows for Tuesday.
  - **wednesday** (array of objects) - Optional - Pause windows for Wednesday.
  - **thursday** (array of objects) - Optional - Pause windows for Thursday.
  - **friday** (array of objects) - Optional - Pause windows for Friday.
  - **saturday** (array of objects) - Optional - Pause windows for Saturday.
  - **advanced** (array of objects) - Optional - Advanced pause window configurations.
    - **startAt** (string, format: date-time) - Required - The start of the advanced pause window.
    - **endAt** (string, format: date-time) - Required - The end of the advanced pause window.

### Request Example
```json
{
  "name": "My Calling Campaign",
  "audienceId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "flowId": "f1e2d3c4-b5a6-0987-6543-210fedcba987",
  "startAt": "2023-10-27T10:00:00Z",
  "stopAt": "2023-10-27T18:00:00Z",
  "didPool": [
    "+15551234567",
    "+15557654321"
  ],
  "retryStrategy": {
    "type": "fixed_delay",
    "delayMinutes": 15,
    "maxRetries": 3
  },
  "pauseWindows": {
    "monday": [
      {
        "startAt": {"hour": 9, "minute": 0},
        "endAt": {"hour": 17, "minute": 0}
      }
    ]
  }
}
```

### Response
#### Success Response (201)
- **id** (string, format: uuid) - The unique identifier for the created program.
- **name** (string) - The name of the program.
- **organizationId** (string, format: uuid) - The ID of the organization the program belongs to.
- **audienceId** (string, format: uuid) - The ID of the audience.
- **flowId** (string, format: uuid) - The ID of the flow.
- **status** (string, enum: ['draft', 'active', 'archived']) - The current status of the program.
- **startAt** (string, format: date-time) - The start date and time.
- **stopAt** (string, format: date-time, nullable: true) - The stop date and time.
- **didPool** (array of strings) - The list of phone numbers used.
- **retryStrategy** (object) - The retry strategy configuration.
- **pauseWindows** (object) - The pause window configuration.
- **createdAt** (string, format: date-time) - The timestamp when the program was created.
- **updatedAt** (string, format: date-time) - The timestamp when the program was last updated.

#### Response Example
```json
{
  "id": "c1d2e3f4-a5b6-7890-fedc-ba9876543210",
  "name": "My Calling Campaign",
  "organizationId": "d2e3f4a5-b6c7-8901-edcb-a9876543210f",
  "audienceId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "flowId": "f1e2d3c4-b5a6-0987-6543-210fedcba987",
  "status": "draft",
  "startAt": "2023-10-27T10:00:00Z",
  "stopAt": "2023-10-27T18:00:00Z",
  "didPool": [
    "+15551234567",
    "+15557654321"
  ],
  "retryStrategy": {
    "type": "fixed_delay",
    "delayMinutes": 15,
    "maxRetries": 3
  },
  "pauseWindows": {
    "monday": [
      {
        "startAt": {"hour": 9, "minute": 0},
        "endAt": {"hour": 17, "minute": 0}
      }
    ]
  },
  "createdAt": "2023-10-26T15:30:00Z",
  "updatedAt": "2023-10-26T15:30:00Z"
}
```

#### Error Response (400)
- Description: Invalid request body or parameters.

#### Error Response (401)
- Description: Unauthorized. Authentication token is missing or invalid.
```
Tokens:
Raw