# Gomobile ## Docs - [End a conversation](https://docs.gomobile.ma/api-reference/agent-studio--conversations/end-a-conversation.md) - [Get conversation details](https://docs.gomobile.ma/api-reference/agent-studio--conversations/get-conversation-details.md) - [Get conversation messages](https://docs.gomobile.ma/api-reference/agent-studio--conversations/get-conversation-messages.md) - [List conversations for an agent](https://docs.gomobile.ma/api-reference/agent-studio--conversations/list-conversations-for-an-agent.md) - [Send a message and stream the response (SSE)](https://docs.gomobile.ma/api-reference/agent-studio--conversations/send-a-message-and-stream-the-response-sse.md) - [Send a message to a conversation](https://docs.gomobile.ma/api-reference/agent-studio--conversations/send-a-message-to-a-conversation.md) - [Start a new conversation with an agent](https://docs.gomobile.ma/api-reference/agent-studio--conversations/start-a-new-conversation-with-an-agent.md) - [Activate agent](https://docs.gomobile.ma/api-reference/agent-studio/activate-agent.md) - [Add a resolution criterion to an agent](https://docs.gomobile.ma/api-reference/agent-studio/add-a-resolution-criterion-to-an-agent.md) - [Archive agent](https://docs.gomobile.ma/api-reference/agent-studio/archive-agent.md) - [Create a new agent](https://docs.gomobile.ma/api-reference/agent-studio/create-a-new-agent.md) - [Delete a resolution criterion](https://docs.gomobile.ma/api-reference/agent-studio/delete-a-resolution-criterion.md) - [Delete agent (soft delete)](https://docs.gomobile.ma/api-reference/agent-studio/delete-agent-soft-delete.md) - [Get agent by ID](https://docs.gomobile.ma/api-reference/agent-studio/get-agent-by-id.md) - [Get resolution metrics for an agent](https://docs.gomobile.ma/api-reference/agent-studio/get-resolution-metrics-for-an-agent.md) - [List all agents](https://docs.gomobile.ma/api-reference/agent-studio/list-all-agents.md) - [List resolution criteria for an agent](https://docs.gomobile.ma/api-reference/agent-studio/list-resolution-criteria-for-an-agent.md) - [Restore archived agent](https://docs.gomobile.ma/api-reference/agent-studio/restore-archived-agent.md) - [Test agent (playground)](https://docs.gomobile.ma/api-reference/agent-studio/test-agent-playground.md) - [Update a resolution criterion](https://docs.gomobile.ma/api-reference/agent-studio/update-a-resolution-criterion.md) - [Update agent](https://docs.gomobile.ma/api-reference/agent-studio/update-agent.md) - [Create a new API key](https://docs.gomobile.ma/api-reference/api-keys/create-a-new-api-key.md) - [Delete an API key](https://docs.gomobile.ma/api-reference/api-keys/delete-an-api-key.md) - [Get all API keys](https://docs.gomobile.ma/api-reference/api-keys/get-all-api-keys.md) - [Get an API key by ID](https://docs.gomobile.ma/api-reference/api-keys/get-an-api-key-by-id.md) - [Update an API key](https://docs.gomobile.ma/api-reference/api-keys/update-an-api-key.md) - [Add contacts to audience](https://docs.gomobile.ma/api-reference/audiences/add-contacts-to-audience.md): Add multiple contacts to an audience segment - [Create a new audience](https://docs.gomobile.ma/api-reference/audiences/create-a-new-audience.md) - [Delete audience](https://docs.gomobile.ma/api-reference/audiences/delete-audience.md) - [Get all audiences for organization with pagination](https://docs.gomobile.ma/api-reference/audiences/get-all-audiences-for-organization-with-pagination.md) - [Get audience by ID](https://docs.gomobile.ma/api-reference/audiences/get-audience-by-id.md) - [Get contacts in audience](https://docs.gomobile.ma/api-reference/audiences/get-contacts-in-audience.md): Get paginated list of contacts belonging to an audience. Supports search and sort. - [Update audience](https://docs.gomobile.ma/api-reference/audiences/update-audience.md) - [Post apiauthlogout](https://docs.gomobile.ma/api-reference/auth/post-apiauthlogout.md) - [Post apiauthlogout all](https://docs.gomobile.ma/api-reference/auth/post-apiauthlogout-all.md) - [Post apiauthrefresh](https://docs.gomobile.ma/api-reference/auth/post-apiauthrefresh.md) - [Post apiauthrevoke session](https://docs.gomobile.ma/api-reference/auth/post-apiauthrevoke-session.md) - [Post apiauthsessions](https://docs.gomobile.ma/api-reference/auth/post-apiauthsessions.md) - [Delete audio file](https://docs.gomobile.ma/api-reference/call-flows/delete-audio-file.md): Delete audio file and remove from storage - [Generate playback URL](https://docs.gomobile.ma/api-reference/call-flows/generate-playback-url.md): Generate a temporary signed URL for audio playback - [Get audio metadata](https://docs.gomobile.ma/api-reference/call-flows/get-audio-metadata.md): Retrieve audio file metadata without streaming content - [Get audio with relations](https://docs.gomobile.ma/api-reference/call-flows/get-audio-with-relations.md): Retrieve audio file with related entities (organization) - [Get audios by usage type](https://docs.gomobile.ma/api-reference/call-flows/get-audios-by-usage-type.md): Retrieve audio files filtered by usage type - [List all audio files](https://docs.gomobile.ma/api-reference/call-flows/list-all-audio-files.md): Get paginated list of audio files with search and sort capabilities - [Stream audio file](https://docs.gomobile.ma/api-reference/call-flows/stream-audio-file.md): Stream audio file directly for playback - [Update audio metadata](https://docs.gomobile.ma/api-reference/call-flows/update-audio-metadata.md): Update audio file metadata (name, description, tags, etc.) - [Upload audio file](https://docs.gomobile.ma/api-reference/call-flows/upload-audio-file.md): Upload and process audio file for use in call flows - [Cancel a queued call](https://docs.gomobile.ma/api-reference/call-requests/cancel-a-queued-call.md) - [Request an ad-hoc call](https://docs.gomobile.ma/api-reference/call-requests/request-an-ad-hoc-call.md) - [Get apicall report](https://docs.gomobile.ma/api-reference/callreport/get-apicall-report.md) - [Get apicall reportcall](https://docs.gomobile.ma/api-reference/callreport/get-apicall-reportcall.md) - [Execute the contact import](https://docs.gomobile.ma/api-reference/contact-ingestion/execute-the-contact-import.md): Imports valid contacts from the validated session. Returns import statistics and URL to download failed rows CSV. - [Get paginated validation results](https://docs.gomobile.ma/api-reference/contact-ingestion/get-paginated-validation-results.md): Retrieves validation results for a session with pagination and filtering. - [Upload a CSV or Excel file for contact ingestion](https://docs.gomobile.ma/api-reference/contact-ingestion/upload-a-csv-or-excel-file-for-contact-ingestion.md): Parses the file and creates an ingestion session. Returns session ID and file metadata. - [Validate uploaded data with column mappings](https://docs.gomobile.ma/api-reference/contact-ingestion/validate-uploaded-data-with-column-mappings.md): Applies column mappings to the uploaded data and validates each row. Returns validation results with errors. - [Bulk upsert contacts](https://docs.gomobile.ma/api-reference/contacts/bulk-upsert-contacts.md): Create or update multiple contacts at once. Existing contacts are matched by phone number. - [Create a new contact](https://docs.gomobile.ma/api-reference/contacts/create-a-new-contact.md) - [Delete contact (soft delete)](https://docs.gomobile.ma/api-reference/contacts/delete-contact-soft-delete.md) - [Get all contacts for organization with pagination](https://docs.gomobile.ma/api-reference/contacts/get-all-contacts-for-organization-with-pagination.md) - [Get contact by ID with custom attributes](https://docs.gomobile.ma/api-reference/contacts/get-contact-by-id-with-custom-attributes.md) - [Update contact](https://docs.gomobile.ma/api-reference/contacts/update-contact.md) - [Get credit balance for current organization](https://docs.gomobile.ma/api-reference/credits/get-credit-balance-for-current-organization.md) - [Get credit transaction history for current organization](https://docs.gomobile.ma/api-reference/credits/get-credit-transaction-history-for-current-organization.md) - [Create custom attribute](https://docs.gomobile.ma/api-reference/custom-attributes/create-custom-attribute.md): Define a new custom field for contacts - [Delete custom attribute](https://docs.gomobile.ma/api-reference/custom-attributes/delete-custom-attribute.md) - [Get all custom attributes for organization](https://docs.gomobile.ma/api-reference/custom-attributes/get-all-custom-attributes-for-organization.md) - [Get custom attribute by ID](https://docs.gomobile.ma/api-reference/custom-attributes/get-custom-attribute-by-id.md) - [Update custom attribute](https://docs.gomobile.ma/api-reference/custom-attributes/update-custom-attribute.md) - [Add an entry to a dictionary](https://docs.gomobile.ma/api-reference/dictionaries/add-an-entry-to-a-dictionary.md) - [Create a dictionary for the organization](https://docs.gomobile.ma/api-reference/dictionaries/create-a-dictionary-for-the-organization.md) - [Delete a dictionary](https://docs.gomobile.ma/api-reference/dictionaries/delete-a-dictionary.md) - [Get a dictionary by ID](https://docs.gomobile.ma/api-reference/dictionaries/get-a-dictionary-by-id.md) - [Get a dictionary entry by key](https://docs.gomobile.ma/api-reference/dictionaries/get-a-dictionary-entry-by-key.md) - [Get all dictionaries for the organization](https://docs.gomobile.ma/api-reference/dictionaries/get-all-dictionaries-for-the-organization.md) - [Get all entries for a dictionary](https://docs.gomobile.ma/api-reference/dictionaries/get-all-entries-for-a-dictionary.md) - [Remove an entry from a dictionary](https://docs.gomobile.ma/api-reference/dictionaries/remove-an-entry-from-a-dictionary.md) - [Get DIDs available to the current organization](https://docs.gomobile.ma/api-reference/dids/get-dids-available-to-the-current-organization.md) - [Delete apiflows](https://docs.gomobile.ma/api-reference/flow/delete-apiflows.md) - [Get apiflows](https://docs.gomobile.ma/api-reference/flow/get-apiflows.md) - [Get apiflows 1](https://docs.gomobile.ma/api-reference/flow/get-apiflows-1.md) - [Get apiflowslatest](https://docs.gomobile.ma/api-reference/flow/get-apiflowslatest.md) - [Post apiflows](https://docs.gomobile.ma/api-reference/flow/post-apiflows.md) - [Post apiflowsexecute](https://docs.gomobile.ma/api-reference/flow/post-apiflowsexecute.md) - [Post apiflowsvalidate](https://docs.gomobile.ma/api-reference/flow/post-apiflowsvalidate.md) - [Put apiflows](https://docs.gomobile.ma/api-reference/flow/put-apiflows.md) - [Create a new knowledge base](https://docs.gomobile.ma/api-reference/knowledge-base/create-a-new-knowledge-base.md) - [Delete a document and its vectors](https://docs.gomobile.ma/api-reference/knowledge-base/delete-a-document-and-its-vectors.md) - [Delete knowledge base and all associated data](https://docs.gomobile.ma/api-reference/knowledge-base/delete-knowledge-base-and-all-associated-data.md) - [Get document details](https://docs.gomobile.ma/api-reference/knowledge-base/get-document-details.md) - [Get knowledge base by ID](https://docs.gomobile.ma/api-reference/knowledge-base/get-knowledge-base-by-id.md) - [List documents in a knowledge base](https://docs.gomobile.ma/api-reference/knowledge-base/list-documents-in-a-knowledge-base.md) - [List knowledge bases](https://docs.gomobile.ma/api-reference/knowledge-base/list-knowledge-bases.md) - [Update knowledge base](https://docs.gomobile.ma/api-reference/knowledge-base/update-knowledge-base.md) - [Upload a document to the knowledge base](https://docs.gomobile.ma/api-reference/knowledge-base/upload-a-document-to-the-knowledge-base.md) - [Cancel an execution](https://docs.gomobile.ma/api-reference/program-executions/cancel-an-execution.md) - [Get execution details](https://docs.gomobile.ma/api-reference/program-executions/get-execution-details.md) - [List all executions for the organization](https://docs.gomobile.ma/api-reference/program-executions/list-all-executions-for-the-organization.md) - [Pause a running execution](https://docs.gomobile.ma/api-reference/program-executions/pause-a-running-execution.md) - [Resume a paused execution](https://docs.gomobile.ma/api-reference/program-executions/resume-a-paused-execution.md) - [Get apiprogram execution report](https://docs.gomobile.ma/api-reference/programreport/get-apiprogram-execution-report.md) - [Get apiprogram execution reportbilling](https://docs.gomobile.ma/api-reference/programreport/get-apiprogram-execution-reportbilling.md) - [Get apiprogram execution reportbreakdown](https://docs.gomobile.ma/api-reference/programreport/get-apiprogram-execution-reportbreakdown.md) - [Get apiprogram execution reportcalls](https://docs.gomobile.ma/api-reference/programreport/get-apiprogram-execution-reportcalls.md) - [Get apiprogram execution reportcallsexport](https://docs.gomobile.ma/api-reference/programreport/get-apiprogram-execution-reportcallsexport.md) - [Get apiprogram execution reportconnect agent](https://docs.gomobile.ma/api-reference/programreport/get-apiprogram-execution-reportconnect-agent.md) - [Get apiprogram execution reportexport](https://docs.gomobile.ma/api-reference/programreport/get-apiprogram-execution-reportexport.md) - [Get apiprogram execution reportnode stats](https://docs.gomobile.ma/api-reference/programreport/get-apiprogram-execution-reportnode-stats.md) - [Create a new program](https://docs.gomobile.ma/api-reference/programs/create-a-new-program.md) - [Delete a program](https://docs.gomobile.ma/api-reference/programs/delete-a-program.md) - [Get program details](https://docs.gomobile.ma/api-reference/programs/get-program-details.md) - [Launch a program execution](https://docs.gomobile.ma/api-reference/programs/launch-a-program-execution.md) - [List all executions for a program](https://docs.gomobile.ma/api-reference/programs/list-all-executions-for-a-program.md) - [List all programs for the organization](https://docs.gomobile.ma/api-reference/programs/list-all-programs-for-the-organization.md) - [List contact triggers for a live program](https://docs.gomobile.ma/api-reference/programs/list-contact-triggers-for-a-live-program.md) - [Update a program](https://docs.gomobile.ma/api-reference/programs/update-a-program.md) - [Delete recording](https://docs.gomobile.ma/api-reference/recordings/delete-recording.md): Soft delete a recording - [Download recording](https://docs.gomobile.ma/api-reference/recordings/download-recording.md): Download recording as a file - [Get recording metadata](https://docs.gomobile.ma/api-reference/recordings/get-recording-metadata.md): Get recording metadata without audio content - [List recordings](https://docs.gomobile.ma/api-reference/recordings/list-recordings.md): Get paginated list of call recordings - [List recordings by call](https://docs.gomobile.ma/api-reference/recordings/list-recordings-by-call.md): Get all recordings for a specific call - [Stream recording](https://docs.gomobile.ma/api-reference/recordings/stream-recording.md): Stream recording audio for playback - [Get sender IDs available to the current organization](https://docs.gomobile.ma/api-reference/sender-ids/get-sender-ids-available-to-the-current-organization.md) - [Cancel SMS program](https://docs.gomobile.ma/api-reference/sms-programs/cancel-sms-program.md): Cancel a running or pending SMS campaign. Best-effort - some messages may still be sent. - [Create a new SMS program](https://docs.gomobile.ma/api-reference/sms-programs/create-a-new-sms-program.md): Creates a new SMS program in draft status. - [Delete SMS program](https://docs.gomobile.ma/api-reference/sms-programs/delete-sms-program.md): Delete program. Only allowed when status is draft. - [Get all SMS programs for organization](https://docs.gomobile.ma/api-reference/sms-programs/get-all-sms-programs-for-organization.md): List SMS programs with pagination, search, and status filter. - [Get SMS program by ID](https://docs.gomobile.ma/api-reference/sms-programs/get-sms-program-by-id.md): Returns program details including current progress. - [Launch SMS program](https://docs.gomobile.ma/api-reference/sms-programs/launch-sms-program.md): Start sending SMS to audience contacts. Transitions from draft to pending/sending. - [Update SMS program](https://docs.gomobile.ma/api-reference/sms-programs/update-sms-program.md): Update program details. Only allowed when status is draft. - [Send a single SMS to a contact](https://docs.gomobile.ma/api-reference/sms/send-a-single-sms-to-a-contact.md) - [Get current user profile with organization](https://docs.gomobile.ma/api-reference/users/get-current-user-profile-with-organization.md) - [Changelog](https://docs.gomobile.ma/changelog/overview.md): Latest updates and changes to the Gomobile API - [API Keys](https://docs.gomobile.ma/core-concepts/api-keys.md): Create, list, update, and delete long-lived API keys - [Audiences](https://docs.gomobile.ma/core-concepts/audiences.md): Group contacts into targetable audiences for campaigns - [Auth API](https://docs.gomobile.ma/core-concepts/auth-api.md): Token refresh, sessions, and logout endpoints - [Contacts](https://docs.gomobile.ma/core-concepts/contacts.md): Create, update, search, and manage contacts - [Executions](https://docs.gomobile.ma/core-concepts/executions.md): Running instances of programs that track progress and status - [Flows](https://docs.gomobile.ma/core-concepts/flows.md): Define what happens during a call with node-based logic - [Organizations](https://docs.gomobile.ma/core-concepts/organizations.md): Organization settings, configuration, and management - [Core Concepts](https://docs.gomobile.ma/core-concepts/overview.md): The fundamental building blocks of Gomobile - [Programs](https://docs.gomobile.ma/core-concepts/programs.md): Campaign configurations combining audience, flow, schedule, and retry rules - [Users](https://docs.gomobile.ma/core-concepts/users.md): User profile and account management - [Ad-hoc Calls](https://docs.gomobile.ma/features/ad-hoc-calls.md): Make individual calls outside of campaigns - [Agents](https://docs.gomobile.ma/features/agent-studio/agents.md): Create and manage AI agents for voice conversations - [Conversations](https://docs.gomobile.ma/features/agent-studio/conversations.md): View and manage AI agent conversation history and transcripts - [End Call Tool](https://docs.gomobile.ma/features/agent-studio/end-call-tool.md): Configure how AI agents end calls and collect resolution data - [Knowledge Base](https://docs.gomobile.ma/features/agent-studio/knowledge-base.md): RAG-powered knowledge bases for AI agent context - [Resolution Criteria](https://docs.gomobile.ma/features/agent-studio/resolution-criteria.md): Define success criteria for AI agent conversations - [Voice Agents](https://docs.gomobile.ma/features/agent-studio/voice-agents.md): Connect AI agents to call flows with the CONNECT_AGENT node - [Audio Management](https://docs.gomobile.ma/features/audio-management.md): Upload, organize, and manage audio files for call flows - [Call Flows](https://docs.gomobile.ma/features/call-flows.md): Define call logic with nodes, branches, and conditions - [Call Reports](https://docs.gomobile.ma/features/call-reports.md): Detailed reports for individual calls and call jobs - [Contact Ingestion](https://docs.gomobile.ma/features/contact-ingestion.md): Bulk import contacts from CSV or Excel files - [Credits](https://docs.gomobile.ma/features/credits.md): Check balances and view credit transaction history - [Custom Attributes](https://docs.gomobile.ma/features/custom-attributes.md): Define and manage custom data fields for contacts - [Dictionaries](https://docs.gomobile.ma/features/dictionaries.md): Dynamic word and number audio playback using dictionary entries - [DIDs](https://docs.gomobile.ma/features/dids.md): Manage phone numbers (DIDs) used as caller IDs - [Execution Reports](https://docs.gomobile.ma/features/execution-reports.md): Detailed analytics and reporting for program executions - [Features](https://docs.gomobile.ma/features/overview.md): Rich set of features for building sophisticated calling campaigns - [Pause Windows](https://docs.gomobile.ma/features/pause-windows.md): Define times when calls should NOT be made - [Recordings](https://docs.gomobile.ma/features/recordings.md): Access and manage call recordings and transcriptions - [Retry Strategies](https://docs.gomobile.ma/features/retry-strategies.md): Configure how failed calls are retried - [Sender IDs](https://docs.gomobile.ma/features/sender-ids.md): Manage alphanumeric sender IDs for SMS campaigns - [SMS](https://docs.gomobile.ma/features/sms.md): Send individual SMS messages to contacts - [SMS Programs](https://docs.gomobile.ma/features/sms-programs.md): Bulk SMS campaigns with audience targeting and scheduling - [Authentication](https://docs.gomobile.ma/getting-started/authentication.md): How to authenticate your API requests with Gomobile - [Installation](https://docs.gomobile.ma/getting-started/installation.md): Getting started with Gomobile takes just a few minutes - [Making Your First Call](https://docs.gomobile.ma/getting-started/making-your-first-call.md): Complete walkthrough of making an automated call with Gomobile - [Getting Started](https://docs.gomobile.ma/getting-started/overview.md): Walk through setting up Gomobile and making your first automated campaign - [Project Structure](https://docs.gomobile.ma/getting-started/project-structure.md): Understanding how Gomobile organizes resources helps you design better campaigns - [Building Your First Campaign](https://docs.gomobile.ma/guides/building-your-first-campaign.md): Complete walkthrough of creating and launching a calling campaign - [Designing Call Flows](https://docs.gomobile.ma/guides/designing-call-flows.md): Build effective call flows for different scenarios - [Handling Failed Calls](https://docs.gomobile.ma/guides/handling-retries.md): Improve your connection rate with smart retry strategies - [Managing Contacts at Scale](https://docs.gomobile.ma/guides/managing-contacts.md): Strategies for importing, organizing, and maintaining large contact databases - [Guides](https://docs.gomobile.ma/guides/overview.md): Practical, step-by-step tutorials for common Gomobile tasks - [Frequently Asked Questions](https://docs.gomobile.ma/help-center/faq.md): Find answers to the most common questions about Gomobile - [Glossary](https://docs.gomobile.ma/help-center/glossary.md): Key terms and definitions used throughout Gomobile - [Help Center](https://docs.gomobile.ma/help-center/overview.md): Find answers to common questions, troubleshooting guides, and resources - [Troubleshooting Guide](https://docs.gomobile.ma/help-center/troubleshooting.md): Common issues and how to resolve them - [About Gomobile](https://docs.gomobile.ma/index.md): Omni-channel communication platform for building intelligent customer engagement campaigns ## OpenAPI Specs - [openapi](https://docs.gomobile.ma/openapi.json) - [file](https://docs.gomobile.ma/file.yaml)