Nexmo Stitch API


Nexmo Stitch API

Version: 1.6.0   •   License: Nexmo Stitch API   •   Contact: Nexmo DevRel, devrel@nexmo.com


Nexmo Stitch API

The Nexmo Stitch API enables you to build conversation features where communication can take place across multiple mediums including IP Messaging, PSTN Voice, SMS and WebRTC Audio and Video. The context of the conversations is maintained though each communication event taking place within a conversation, no matter the medium.

Conversation

A conversation is a shared core component that Nexmo APIs rely on. Conversations happen over multiple mediums and and can have associated Users through Memberships.

Create a conversation

List conversations

Update a conversation

Retrieve a conversation

Delete a conversation

User

The concept of a user exists in Nexmo APIs, you can associate one with a user in your own application if you choose. A user can have multiple memberships to conversations and can communicate with other users through various different mediums.

List users

Create a user

Retrieve a user

Update a user

Delete a user

List user conversations

Member

Memberships connect users with conversations. Each membership has one conversation and one user however a user can have many memberships to conversations just as conversations can have many members.

List members

Create a member

Retrieve a member

Update a member

Delete a member

Event

Events are actions that occur within a conversation. Examples of this includes: Text events from members, or invite events from users

Create an event

List events

Retrieve an event

Delete an event

Leg

A leg can be a video call, IP call, or PSTN call that users participate in using multiple platforms. With this endpoint you can retrieve the details about all of the legs that took place in your application.

List legs

Delete a leg

Models

leg_state

Property

Required

Type

Description

conversation_id

Property

Required

Type

Description

member_id

Property

Required

Type

Description

member_id_inviting

Property

Required

Type

Description

member_action

Property

Required

Type

Description

user_id_or_user_name

Property

Required

Type

Description

user_id

Property

Required

Type

Description

name

Property

Required

Type

Description

name_conversation

Property

Required

Type

Description

name_user

Property

Required

Type

Description

href

Property

Required

Type

Description

href_conversation

Property

Required

Type

Description

href_conversations_list

Property

Required

Type

Description

href_member

Property

Required

Type

Description

href_user

Property

Required

Type

Description

href_event

Property

Required

Type

Description

href_rtc

Property

Required

Type

Description

event_id

Property

Required

Type

Description

image_url

Property

Required

Type

Description

display_name

Property

Required

Type

Description

display_name_user

Property

Required

Type

Description

numbers

Property

Required

Type

Description

sms

false

string

phone number used for sms channel

pstn

false

string

phone number used for pstn channel

conversation_properties

Property

Required

Type

Description

speaking_detection_level

false

number


ttl

false

number

Time to leave

Property

Required

Type

Description

self

false

object


Property

Required

Type

Description

self

false

object


page_size

Property

Required

Type

Description

record_index

Property

Required

Type

Description

timestamp

Property

Required

Type

Description

timestamp_created

Property

Required

Type

Description

timestamp_updated

Property

Required

Type

Description

timestamp_destroyed

Property

Required

Type

Description

timestamp_leg_start_time

Property

Required

Type

Description

timestamp_leg_end_time

Property

Required

Type

Description

timestamp_res_event

Property

Required

Type

Description

timestamp_res_conversation

Property

Required

Type

Description

created

false

string

Time of creation

updated

false

string

Time of last update

destroyed

false

string

Time of last update

timestamp_res_member

Property

Required

Type

Description

invited

false

string

Timestamp

joined

false

string

Timestamp

left

false

string

Timestamp

timestamp_obj_leg

Property

Required

Type

Description

start

false

string

Time of creation

end

false

string

Timestamp

request

false

string

Timestamp

member_state

Property

Required

Type

Description

leg_id

Property

Required

Type

Description

channel_number

Property

Required

Type

Description

channel_type

Property

Required

Type

Description

channel

Property

Required

Type

Description

type

false

string

Channel type

leg_id

false

string

The id of the leg. rtc_id and call_id are leg id

from

false

object


to

false

object


leg_ids

false

object[]


media

Property

Required

Type

Description

event_type

Property

Required

Type

Description

event_body

Property

Required

Type

Description

event_retrieved

Property

Required

Type

Description

id

false

string

Event id. This is a progressive integer

type

false

string

Event type

from

false

string

Member ID

to

false

string

Member ID

body

false

object

Event Body

state

false

string

The state that the member is in. Possible values are `invited`, `joined`, `left`, or `unknown`

timestamp

false

string

Time of creation

href

false

string

A link towards a conversation event included in Conversation Service API

knocker_id

Property

Required

Type

Description