Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Mobile First Company Conversations API

The Conversations API from The Mobile First Company — 7 operation(s) for conversations.

The Mobile First Company Conversations API is one of 13 APIs that The Mobile First Company publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 7 paths, and defines 20 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.withallo.com.

7 operations 7 paths 20 schemas 3 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.withallo.com
Authentication
API Key, API Key, API Key, API Key, API Key
Contact
Allo Support
Resource Areas
1

Authentication & Security 5

The Mobile First Company Conversations API declares 5 security schemes for authenticating requests. An API key is passed in the header as Authorization (CallsAuth). An API key is passed in the header as Authorization (ContactsAuth). An API key is passed in the header as Authorization (ContactsWriteAuth). An API key is passed in the header as Authorization (SmsAuth). An API key is passed in the header as Authorization (ApiKeyAuth).

  • CallsAuth — Scope needed: CONVERSATIONSREAD
  • ContactsAuth — Scope needed: CONTACTSREAD
  • ContactsWriteAuth — Scope needed: CONTACTSREADWRITE
  • SmsAuth — Scope needed: SMSSEND

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Conversations 7
GET
/v1/api/contact/{contact_id}/conversation
Search Conversations
getContactConversation 4 params → 200400401403429
GET
/v2/api/conversations
List conversations
listConversations 6 params → 200401429
POST
/v2/api/conversations/items/search
Search all conversations
searchAllConversations body → 200400401429
GET
/v2/api/conversations/items/{id}
Get conversation item
getConversationItem 2 params → 200401404429
PATCH
/v2/api/conversations/items/{id}/summary
Update call summary
updateCallSummary 1 param body → 200400401404429
POST
/v2/api/conversations/items/batch
Get many conversation items
batchGetConversationItems body → 200400401429
PUT
/v2/api/conversations/{contact_number}/action
Execute conversation action
executeConversationAction 1 param body → 200401404429

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ConversationItem (17 properties), ItemSearchRequest (15 properties), CallApiResponse (11 properties), TextMessageApiResponse (6 properties). Each schema is shown below with its type and property counts.

CallSummary
object
5 properties
TextMessageApiResponse
object
Sent SMS message details
6 properties
ErrorDetail
object
2 properties
ConversationApiResponse
object
Paginated conversation history with calls and messages
2 properties
TranscriptEntry
object
3 properties
ConversationItem
object
17 properties
TranscriptRow
object
A single row in the call transcript
5 properties
ConversationItemApiResponse
object
A single item in the conversation (either a call or a message)
3 properties
ErrorResponse
object
2 properties
PaginatedResponse
object
1 property
ConversationSummary
object
4 properties
AnalyticsDateRange
object
2 properties 2 required
CallApiResponse
object
A call record with details about the conversation
11 properties
GetContactConversationResponse
object
Standard response wrapper for contact conversation
1 property
Contact
object
4 properties
ItemSearchRequest
object
15 properties
PaginationMeta
object
Pagination metadata wrapper for contacts endpoint
1 property
UserRef
object
3 properties
Pagination
object
5 properties
ApiError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-mobile-first-company-conversations-api-openapi.yml Raw ↑

Other APIs The Mobile First Company publishes across the network.

The Mobile First Company Analytics API
The Mobile First Company Calls API
The Mobile First Company Contacts API
The Mobile First Company CRM API
The Mobile First Company Partner API
The Mobile First Company Phone Numbers API
The Mobile First Company Power Dialer API
The Mobile First Company SMS API
The Mobile First Company Summary Templates API
The Mobile First Company Tags API
The Mobile First Company Users API
The Mobile First Company Webhooks API