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

ActionWhat it does
Create contactCreate a contact.
Create contact noteCreate a contact note.
Delete contactDelete a contact.
Delete contact noteDelete a contact note.
Get callGet a call by ID.
Get contactGet a contact by ID.
Get contact noteGet a contact note by ID.
Get messageGet a message by ID.
Get organizationGet the organization.
Get phone numberGet a phone number by ID.
Get taskGet a task by task ID.
Get userGet a user by ID.
List call recordingsList recordings for a call.
List call transcriptsList transcripts for a call.
List callsList calls.
List contact notesList notes for a contact.
List contactsList contacts.
List conversationsList conversations.
List messagesList messages.
List phone numbersList phone numbers.
List tasksList tasks.
List usersList users.
Send text messageSend a real text message from your number to up to ten recipients.
Update contactUpdate a contact by ID.
Update contact noteUpdate a contact note.

Create contact

Create a contact.

Inputs

First namefirst_nametextRequired
The first name of the contact.
Last namelast_nametext
The last name of the contact.
Companycompanytext
The company of the contact.
Roleroletext
The role of the contact.
External idexternal_idtext
The external ID of the contact.
Sourcesourcetext
The source of the contact.
Source urlsource_urltext
A link to the contact in the source system.
Actoractor_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 idcontact_idtextRequired
The unique identifier of the contact whose notes are being listed.
TexttexttextRequired
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 idcontact_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 idcontact_idtextRequired
The unique identifier of the contact the note belongs to.
Note idnote_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 idcall_idtextRequired
Unique identifier of the call.
Includeincludelist
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 idcontact_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 idcontact_idtextRequired
The unique identifier of the contact the note belongs to.
Note idnote_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 idmessage_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 numberphone_number_idtextRequired
The unique identifier of the phone number being referenced (used).
Includeincludelist
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 idtask_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 userquo_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 idcall_idtextRequired
The unique identifier of the call whose recordings are being listed.
Limitlimitnumber
Max number of items to return per page.From 1 to 50.
Afteraftertext
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 idcall_idtextRequired
The unique identifier of the call whose transcripts are being listed.
Limitlimitnumber
Max number of items to return per page.From 1 to 50.
Afteraftertext
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

Includeincludelist
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 numberphone_number_idtext
Only return calls on this Quo number.
Actoractor_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.
Participantparticipanttext
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.
Directiondirectiontext
The direction of the call relative to the Quo number.One of: incoming, outgoing.
Statusstatustext
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 gtecreated_at_gtedate and time
Only return calls created at or after this timestamp. The bound is inclusive.
Created at ltecreated_at_ltedate and time
Only return calls created at or before this timestamp. The bound is inclusive.
Limitlimitnumber
Max number of items to return per page.From 1 to 50.
Afteraftertext
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 idcontact_idtextRequired
The unique identifier of the contact whose notes are being listed.
Limitlimitnumber
Max number of items to return per page.From 1 to 50.
Afteraftertext
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 idexternal_idtext
Filter by external ID, such as `externalId=ext-1`. To match any of several, use `externalId[in]=ext-1,ext-2`.
Sourcesourcetext
Filter by source label, such as `source=openphone-hubspot`. To match any of several, use `source[in]=openphone-hubspot,openphone-salesforce`.
Limitlimitnumber
Page sizeFrom 1 to 50.
Afteraftertext
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 numberphone_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 gtecreated_at_gtedate and time
The created at gte.
Created at ltecreated_at_ltedate and time
The created at lte.
Updated at gteupdated_at_gtedate and time
The updated at gte.
Updated at lteupdated_at_ltedate and time
The updated at lte.
Sortsorttext
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.
Limitlimitnumber
Max number of items to return per page.From 1 to 50.
Afteraftertext
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 numberfrom_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).
Tototext
A phone number in E.164 format, a short code (3-8 digits), or a non-phone-number caller ID (Anonymous, Restricted, or Blocked).
Statusstatustext
The status of the message.One of: queued, sent, delivered, undelivered, received, failed.
Directiondirectiontext
The direction of the message relative to the Quo number.One of: incoming, outgoing.
Phone numberphone_number_idtext
The phone number id.
Quo userquo_user_idtext
The user id.
Created at gtcreated_at_gtdate and time
The created at gt.
Created at ltcreated_at_ltdate and time
The created at lt.
Limitlimitnumber
Max number of items to return per page.From 1 to 50.
Afteraftertext
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

Limitlimitnumber
Max number of items to return per page.From 1 to 50.
Afteraftertext
The after.
Phone numberphone_numbertext
Filter results to the phone number matching this E.164 value.
Includeincludelist
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

Limitlimitnumber
Max number of items to return per page.From 1 to 100.
Afteraftertext
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

Limitlimitnumber
Max number of items to return per page.From 1 to 50.
Afteraftertext
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

SendersendertextRequired
Select your Quo number or enter its number in international format.
RecipientsrecipientslistRequired
Recipient phone numbers in international format, such as +14155552671.
ContentcontenttextRequired
The message text, up to 1600 characters.
Quo userquo_user_idtext
Send as this user. Leave empty to use the phone number owner.
Inbox statusinbox_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 idcontact_idtextRequired
The unique identifier of the contact being updated.
First namefirst_nametext
The first name of the contact.
Last namelast_nametext
The last name of the contact.
Companycompanytext
The company of the contact.
Roleroletext
The role of the contact.
External idexternal_idtext
The external ID of the contact.
Sourcesourcetext
The source of the contact.
Source urlsource_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 idcontact_idtextRequired
The unique identifier of the contact the note belongs to.
Note idnote_idtextRequired
The unique identifier of the note to update.
TexttexttextRequired
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"
    }
  }
}

On this page