Live
It is possible to craft a link directly to the Vision Web Live Call console without this API, but this interface allows for additional information to be associated with the call. Most notably, an integrator can include an integration ID from their system to associate with the call. If provided, any web hooks fired in relation to a content item associated with this live call will include that integration ID.
API URLs
- Testing:
https://gql-live-external.staging.xoeye.com/graphql
- Production:
https://gql-live-external.xoi.io/graphql
Preparing a Vision Live call
Example Request
The following request will store data regarding a Vision Live call, then return a valid URL for initiating the call in the Vision Web application.
See the PrepareVisionLiveCallInput schema for the details of what is required for this request.
mutation {
prepareVisionLiveCall(
input: {
invitations: [{ type: sms, recipient: "2223334444" }]
integrationEntityId: { namespace: "anamespace", id: "INTEG_ID" }
callMetadataJSON: "{\"key\":\"VALUE\"}"
}
) {
visionLiveCall {
id
invitations {
type
recipient
}
integrationEntityId {
namespace
id
}
callMetadataJSON
visionLiveLink
}
}
}
Example Response
See the PrepareVisionLiveCallResult schema for the details of what to expect in your response.
{
"data": {
"prepareVisionLiveCall": {
"visionLiveCall": {
"id": "call-be76aecd347e4fe89e5e666372a57af9",
"invitations": [
{
"type": "sms",
"recipient": "2223334444"
}
],
"integrationEntityId": {
"namespace": "anamespace",
"id": "INTEG_ID"
},
"callMetadataJSON": "{\"key\":\"VALUE\"}"
}
}
}
}
Retrieving data about a prepared Vision Live call.
When sending the prepareVisionLiveCall
query discussed above, we opted to have the id
returned. We can now use that id
to retrieve the data about a specific Vision Live call.
Example Request
See the GetVisionLiveCallInput schema for the details of what is required for this request.
query {
getVisionLiveCall(input: { id: "call-VISIONLIVECALLID" }) {
visionLiveCall {
id
invitations {
type
recipient
}
integrationEntityId {
namespace
id
}
callMetadataJSON
visionLiveLink
}
}
}
Example Response
See the GetVisionLiveCallResult schema for the details of what to expect in your response.
{
"data": {
"getVisionLiveCall": {
"visionLiveCall": {
"id": "call-VISIONLIVECALLID",
"invitations": [
{
"type": "sms",
"recipient": "2223334444"
}
],
"integrationEntityId": {
"namespace": "anamespace",
"id": "INTEG_ID"
},
"callMetadataJSON": "{\"key\":\"VALUE\"}"
}
}
}
}