openapi: 3.1.0
info:
title: Phonic
version: 0.1.0
paths:
/call/schedule:
post:
summary: Schedule Call
operationId: schedule_call_call_schedule_post
parameters:
- name: x-api-key
in: header
required: true
schema:
type: string
title: X-Api-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleCallRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/call/schedule/cancel:
post:
summary: Cancel Scheduled Calls
operationId: cancel_scheduled_calls_call_schedule_cancel_post
parameters:
- name: x-api-key
in: header
required: true
schema:
type: string
title: X-Api-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelScheduledCallRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
CancelScheduledCallRequest:
properties:
recipient:
$ref: '#/components/schemas/Recipient'
type:
anyOf:
- type: string
- type: 'null'
title: Type
type: object
required:
- recipient
- type
title: CancelScheduledCallRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
InstantCallRequest:
properties:
phone_number:
type: string
title: Phone Number
type: object
required:
- phone_number
title: InstantCallRequest
Recipient:
properties:
phone_number:
type: string
title: Phone Number
first_name:
anyOf:
- type: string
- type: 'null'
title: First Name
last_name:
anyOf:
- type: string
- type: 'null'
title: Last Name
type: object
required:
- phone_number
- first_name
- last_name
title: Recipient
ScheduleCallRequest:
properties:
recipient:
$ref: '#/components/schemas/Recipient'
type:
type: string
title: Type
type: object
required:
- recipient
- type
title: ScheduleCallRequest
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError