WIwithallo
AI Receptionist

Turn the AI receptionist on or off

Changed on

Puts the receptionist on the line (ACTIVE) or takes it off (FORWARDING, which sends calls to your business phone instead). This reprograms how a live line routes real calls, so confirm with a person before calling it.

put/v2/api/numbers/{number}/agent/status

Request

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

Path parameters

numberstring required
Example:+14155551234

Allo phone number in E.164 format

Request body

status'ACTIVE' | 'FORWARDING' required

ACTIVE puts the receptionist on the line. FORWARDING takes it off and sends calls to your business phone.

Response

The configuration, with the new status

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