Quo
App · 25 actions
Manage Quo contacts and notes, send text messages, read conversations, messages and calls, download call recordings and transcripts, and track tasks.
Actions
| Action | What it does |
|---|---|
| Create contact | Create a contact. |
| Create contact note | Create a contact note. |
| Delete contact | Delete a contact. |
| Delete contact note | Delete a contact note. |
| Get call | Get a call by ID. |
| Get contact | Get a contact by ID. |
| Get contact note | Get a contact note by ID. |
| Get message | Get a message by ID. |
| Get organization | Get the organization. |
| Get phone number | Get a phone number by ID. |
| Get task | Get a task by task ID. |
| Get user | Get a user by ID. |
| List call recordings | List recordings for a call. |
| List call transcripts | List transcripts for a call. |
| List calls | List calls. |
| List contact notes | List notes for a contact. |
| List contacts | List contacts. |
| List conversations | List conversations. |
| List messages | List messages. |
| List phone numbers | List phone numbers. |
| List tasks | List tasks. |
| List users | List users. |
| Send text message | Send a real text message from your number to up to ten recipients. |
| Update contact | Update a contact by ID. |
| Update contact note | Update a contact note. |
Create contact
Create a contact.
Inputs
- First name
first_nametextRequired - The first name of the contact.
- Last name
last_nametext - The last name of the contact.
- Company
companytext - The company of the contact.
- Role
roletext - The role of the contact.
- External id
external_idtext - The external ID of the contact.
- Source
sourcetext - The source of the contact.
- Source url
source_urltext - A link to the contact in the source system.
- Actor
actor_idtext - The actor ID to attribute contact creation to. Defaults to the organization owner.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Create contact note
Create a contact note.
Inputs
- Contact id
contact_idtextRequired - The unique identifier of the contact whose notes are being listed.
- Text
texttextRequired - The body of the note. Mentions using the @USxxx / @GRxxx / @ORxxx tag syntax are automatically detected and resolved.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Delete contact
Delete a contact.
Inputs
- Contact id
contact_idtextRequired - The unique identifier of the contact to delete.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Delete contact note
Delete a contact note.
Inputs
- Contact id
contact_idtextRequired - The unique identifier of the contact the note belongs to.
- Note id
note_idtextRequired - The unique identifier of the note to delete.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Get call
Get a call by ID.
Inputs
- Call id
call_idtextRequired - Unique identifier of the call.
- Include
includelist - Comma-separated list of optional payload sections to include. `summary` adds the call’s summary, `voicemail` the voicemail left on it. Omitted sections are left out of the response entirely, and `voicemail` is also left out for a call where none was left.One or more of:
summary,voicemail.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Get contact
Get a contact by ID.
Inputs
- Contact id
contact_idtextRequired - The unique identifier of the contact being retrieved.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Get contact note
Get a contact note by ID.
Inputs
- Contact id
contact_idtextRequired - The unique identifier of the contact the note belongs to.
- Note id
note_idtextRequired - The unique identifier of the note to retrieve.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Get message
Get a message by ID.
Inputs
- Message id
message_idtextRequired - The unique identifier of the message.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Get organization
Get the organization.
Inputs
None.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Get phone number
Get a phone number by ID.
Inputs
- Phone number
phone_number_idtextRequired - The unique identifier of the phone number being referenced (used).
- Include
includelist - Comma-separated list of optional payload sections to include. `restrictions` adds the number’s calling and messaging restrictions. `businessHours` adds the number’s business hours: whether they are enforced, their timezone, and the window for each day; with nothing stored, `enabled` is `false`, `timezone` is `America/Los_Angeles` and the schedule is `null`. `businessHours` is only available on this endpoint, not on the list. Omitted sections are left out of the response entirely. The members assigned to a number are their own endpoint, `GET /phone-numbers/{phoneNumberId}/users`.One or more of:
restrictions,businessHours.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Get task
Get a task by task ID.
Inputs
- Task id
task_idtextRequired - The unique identifier of the task.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Get user
Get a user by ID.
Inputs
- Quo user
quo_user_idtextRequired - The unique identifier of the user being retrieved.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}List call recordings
List recordings for a call.
Inputs
- Call id
call_idtextRequired - The unique identifier of the call whose recordings are being listed.
- Limit
limitnumber - Max number of items to return per page.From 1 to 50.
- After
aftertext - The after.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}List call transcripts
List transcripts for a call.
Inputs
- Call id
call_idtextRequired - The unique identifier of the call whose transcripts are being listed.
- Limit
limitnumber - Max number of items to return per page.From 1 to 50.
- After
aftertext - The after.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}List calls
List calls.
Inputs
- Include
includelist - Comma-separated list of optional payload sections to include. `summary` adds the call’s summary, `voicemail` the voicemail left on it. Omitted sections are left out of the response entirely, and `voicemail` is also left out for a call where none was left.One or more of:
summary,voicemail. - Phone number
phone_number_idtext - Only return calls on this Quo number.
- Actor
actor_idtext - Only return calls belonging to this Quo user or system actor. An AI agent is a system actor, so its calls are reached with its `SYU` id.
- Participant
participanttext - Only return calls whose own originating or receiving number is this E.164 number, such as `participant=+15555555555`. To match any of several numbers, use `participant[in]=+15555555555,+15555555556`. Note that this is narrower than the `participants` array in the response: a party who joined a group call beyond those two numbers is listed in the response but is not matched by this filter.
- Direction
directiontext - The direction of the call relative to the Quo number.One of:
incoming,outgoing. - Status
statustext - Only return calls with this status, such as `status=missed`. To match any of several statuses, use `status[in]=missed,no-answer`.One of:
queued,initiated,ringing,in-progress,completed,busy,failed,no-answer,canceled,missed, and 3 more. - Created at gte
created_at_gtedate and time - Only return calls created at or after this timestamp. The bound is inclusive.
- Created at lte
created_at_ltedate and time - Only return calls created at or before this timestamp. The bound is inclusive.
- Limit
limitnumber - Max number of items to return per page.From 1 to 50.
- After
aftertext - The after.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}List contact notes
List notes for a contact.
Inputs
- Contact id
contact_idtextRequired - The unique identifier of the contact whose notes are being listed.
- Limit
limitnumber - Max number of items to return per page.From 1 to 50.
- After
aftertext - The after.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}List contacts
List contacts.
Inputs
- External id
external_idtext - Filter by external ID, such as `externalId=ext-1`. To match any of several, use `externalId[in]=ext-1,ext-2`.
- Source
sourcetext - Filter by source label, such as `source=openphone-hubspot`. To match any of several, use `source[in]=openphone-hubspot,openphone-salesforce`.
- Limit
limitnumber - Page sizeFrom 1 to 50.
- After
aftertext - The after.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}List conversations
List conversations.
Inputs
- Phone number
phone_number_idtext - Only return conversations on this Quo phone number ID, such as `phoneNumberId=PN123abc`. To match any of several, use `phoneNumberId[in]=PN123abc,PN456def` (max 100). Matches the Quo phone number only, not participant numbers.
- Created at gte
created_at_gtedate and time - The created at gte.
- Created at lte
created_at_ltedate and time - The created at lte.
- Updated at gte
updated_at_gtedate and time - The updated at gte.
- Updated at lte
updated_at_ltedate and time - The updated at lte.
- Sort
sorttext - A single field:direction pair. Allowed fields: createdAt, updatedAt. Direction must be asc or desc.One of:
createdAt:desc,createdAt:asc,updatedAt:desc,updatedAt:asc. - Limit
limitnumber - Max number of items to return per page.From 1 to 50.
- After
aftertext - The after.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}List messages
List messages.
Inputs
- From number
from_numbertext - A phone number in E.164 format, a short code (3-8 digits), or a non-phone-number caller ID (Anonymous, Restricted, or Blocked).
- To
totext - A phone number in E.164 format, a short code (3-8 digits), or a non-phone-number caller ID (Anonymous, Restricted, or Blocked).
- Status
statustext - The status of the message.One of:
queued,sent,delivered,undelivered,received,failed. - Direction
directiontext - The direction of the message relative to the Quo number.One of:
incoming,outgoing. - Phone number
phone_number_idtext - The phone number id.
- Quo user
quo_user_idtext - The user id.
- Created at gt
created_at_gtdate and time - The created at gt.
- Created at lt
created_at_ltdate and time - The created at lt.
- Limit
limitnumber - Max number of items to return per page.From 1 to 50.
- After
aftertext - The after.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}List phone numbers
List phone numbers.
Inputs
- Limit
limitnumber - Max number of items to return per page.From 1 to 50.
- After
aftertext - The after.
- Phone number
phone_numbertext - Filter results to the phone number matching this E.164 value.
- Include
includelist - Comma-separated list of optional payload sections to include. `restrictions` adds the number’s calling and messaging restrictions. Omitted sections are left out of the response entirely. The members assigned to a number are their own endpoint, `GET /phone-numbers/{phoneNumberId}/users`.One or more of:
restrictions.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}List tasks
List tasks.
Inputs
- Limit
limitnumber - Max number of items to return per page.From 1 to 100.
- After
aftertext - The after.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}List users
List users.
Inputs
- Limit
limitnumber - Max number of items to return per page.From 1 to 50.
- After
aftertext - The after.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": [],
"nextCursor": null
}
}Send text message
Send a real text message from your number to up to ten recipients. Uses the documented v1 messaging endpoint; carrier registration and messaging charges may apply.
Inputs
- Sender
sendertextRequired - Select your Quo number or enter its number in international format.
- Recipients
recipientslistRequired - Recipient phone numbers in international format, such as +14155552671.
- Content
contenttextRequired - The message text, up to 1600 characters.
- Quo user
quo_user_idtext - Send as this user. Leave empty to use the phone number owner.
- Inbox status
inbox_statustext - Move the related conversation to Done. Leave empty to keep the default inbox behavior.One of:
done.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "AC123",
"status": "queued",
"text": "Hello"
}
}
}Update contact
Update a contact by ID.
Inputs
- Contact id
contact_idtextRequired - The unique identifier of the contact being updated.
- First name
first_nametext - The first name of the contact.
- Last name
last_nametext - The last name of the contact.
- Company
companytext - The company of the contact.
- Role
roletext - The role of the contact.
- External id
external_idtext - The external ID of the contact.
- Source
sourcetext - The source of the contact.
- Source url
source_urltext - The source URL of the contact.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}Update contact note
Update a contact note.
Inputs
- Contact id
contact_idtextRequired - The unique identifier of the contact the note belongs to.
- Note id
note_idtextRequired - The unique identifier of the note to update.
- Text
texttextRequired - The updated body of the note.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": {
"id": "qa-resource"
}
}
}