Interface: CallsApi

The methods of Talkline.calls.

Methods

create()

create(body): Promise<CallDetail>;

POST /v1/calls: rings from the server, with nobody connected to place it.

Parameters

Parameter	Type
body	CreateCallRequest

Returns

Promise<CallDetail>

---

end()

end(sid): Promise<CallDetail>;

POST /v1/calls/{sid}/end.

Parameters

Parameter	Type
sid	string

Returns

Promise<CallDetail>

---

events()

events(sid, query?): Promise<Page<CallEvent>>;

GET /v1/calls/{sid}/events: one page of the timeline, oldest first.

Parameters

Parameter	Type
sid	string
query?	PageQuery

Returns

Promise<Page<CallEvent>>

---

get()

get(sid): Promise<CallDetail>;

GET /v1/calls/{sid}.

Parameters

Parameter	Type
sid	string

Returns

Promise<CallDetail>

---

iterate()

iterate(query?): AsyncIterable<Call>;

GET /v1/calls, every page in turn.

Parameters

Parameter	Type
query?	Pageless<ListCallsQuery>

Returns

AsyncIterable<Call>

---

iterateEvents()

iterateEvents(sid, query?): AsyncIterable<CallEvent>;

GET /v1/calls/{sid}/events, every page in turn.

Parameters

Parameter	Type
sid	string
query?	Pageless<PageQuery>

Returns

AsyncIterable<CallEvent>

---

list()

list(query?): Promise<Page<Call>>;

GET /v1/calls, one page.

Parameters

Parameter	Type
query?	ListCallsQuery

Returns

Promise<Page<Call>>