WIwithallo
AI Receptionist

Update AI receptionist configuration

Changed on

Updates any part of the configuration except the prompt and the on/off status. Single values are merged, collections are replaced. This does not put the receptionist on the line: that is PUT /v2/api/numbers/{number}/agent/status.

patch/v2/api/numbers/{number}/agent

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/numbers/{number}/agent
  • Auth
    API key in header Authorization

Path parameters

numberstring required
Example:+14155551234

Allo phone number in E.164 format

Request body

namestring
business_namestring
business_addressstring
business_phonestring

E.164 format.

business_emailstring
business_websitestring
business_industrystring
language'fr' | 'fr-CA' | 'en-US' | 'en-GB' | 'es' | 'de' | 'hr'
voice_idstring

An id from GET /v2/api/voices, listed under the receptionist's language.

greeting_messagestring
closing_messagestring
tone_of_voice'FRIENDLY' | 'PROFESSIONAL' | 'NEUTRAL' | 'ENTHUSIASTIC'
answer_type'CONCISE' | 'STANDARD' | 'DETAILED'
capabilitiesobject

The complete set of toggles. A capability left out of the map is turned off, so read the current ones first and send them all back.

Example request

{
  "name": "Maya",
  "business_name": "Acme Plumbing",
  "business_phone": "+14155551234",
  "language": "en-US",
  "voice_id": "maya",
  "capabilities": {
    "SCHEDULING": true,
    "CALL_TRANSFER": true,
    "WARM_TRANSFER": false
  },
  "business_hours": {
    "timezone": "America/New_York",
    "schedule": [
      {
        "schedule": [
          {
            "start_time": 32400,
            "end_time": 61200
          }
        ]
      }
    ]
  },
  "transfer_rules": [
    {
      "description": "Billing or invoice questions",
      "transfer_message": "Let me put you through to billing.",
      "target_number": "+14155551234"
    }
  ],
  "knowledge": {
    "text": "We serve the Austin metro area and open at 7am."
  }
}

Response

The configuration after the write

Example response

{
  "data": {
    "agent": {
      "id": "agt-abc123",
      "name": "Maya",
      "business_name": "Acme Plumbing",
      "business_address": "12 Main Street, Austin TX",
      "business_phone": "+14155551234",
      "business_email": "hello@acme.test",
      "business_website": "https://acme.test",
      "business_industry": "Plumbing",
      "language": "en-US",
      "voice_id": "maya",
      "greeting_message": "Thanks for calling Acme Plumbing, how can I help?",
      "closing_message": "Thanks for calling, have a good day."
    },
    "prompt": {
      "sections": [
        {
          "title": "Objective",
          "content": "Book a visit with the caller.",
          "fields": [
            {
              "label": "Email",
              "question": "What is the best email to send the quote to?",
              "complete_when": "a valid email address is given"
            }
          ]
        }
      ]
    },
    "business_hours": {
      "timezone": "America/New_York",
      "schedule": [
        {
          "schedule": [
            {
              "start_time": 32400,
              "end_time": 61200
            }
          ]
        }
      ]
    },
    "transfer_rules": [
      {
        "description": "Billing or invoice questions",
        "transfer_message": "Let me put you through to billing.",
        "target_number": "+14155551234"
      }
    ],
    "scheduling": {
      "calendars": [
        {
          "calendar_connection_id": "exc-abc123",
          "name": "Acme bookings",
          "event_types": [
            {
              "id": "42",
              "slug": "intro-call",
              "title": "Intro call",
              "length_in_minutes": 30,
              "description": "Book this one when the caller wants a quote.",
              "required_questions": [
                {
                  "id": "notes",
                  "label": "Anything we should know before the visit?"
                }
              ]
            }
          ]
        }
      ]
    },
    "knowledge": {
      "websites": [
        {
          "id": "ksrc-abc123",
          "url": "https://acme.test/pricing"
        }
      ],
      "files": [
        {
          "id": "ksrc-def456",
          "file_name": "pricing.pdf"
        }
      ]
    }
  }
}

Changes