social

Manages chat, messages and channels using pubnub

Applies moderation to a user

POSThttp://admin.m2worlds.io/api/social/chat/moderation

Authorization

BearerAuth

Header parameters

Body

application/json

action*any of

enumenumenumenumenumenum

channels*array of ChannelNameSchema (string)

userId*string

Response

4XX

Default Response

Body

application/json

error*string

HTTP error message

codestring

Fastify error code

message*string

User error message

statusCode*number

HTTP status code

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/social/chat/moderation', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "muted",
      "channels": [
        "text"
      ],
      "userId": "text"
    }),
});
const data = await response.json();

Response

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Creates a new channel

POSThttp://admin.m2worlds.io/api/social/chat/create

Authorization

BearerAuth

Header parameters

Body

application/json

type*any of

enumenumenum

Response

2004XX

Default Response

Body

application/json

pubnubUid*string

pubnubSubscribeKey*string

pubnubPublishKey*string

pubnubAuthToken*string

channels*array of object

bannedChannels*array of ChannelNameSchema (string)

mutedChannels*array of ChannelNameSchema (string)

defaultChannels*array of object

ttlInMinutes*number

createdChannel*string

Template literal for a channel name

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/social/chat/create', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "party"
    }),
});
const data = await response.json();

Response

{
  "pubnubUid": "text",
  "pubnubSubscribeKey": "text",
  "pubnubPublishKey": "text",
  "pubnubAuthToken": "text",
  "channels": [
    {
      "name": "text",
      "read": false,
      "write": false,
      "type": "party"
    }
  ],
  "bannedChannels": [
    "text"
  ],
  "mutedChannels": [
    "text"
  ],
  "defaultChannels": [
    {
      "read": false,
      "write": false,
      "type": "party"
    }
  ],
  "ttlInMinutes": 0,
  "createdChannel": "text"
}

Adds user to a channel

POSThttp://admin.m2worlds.io/api/social/chat/join

Authorization

BearerAuth

Header parameters

Body

application/json

channels*array of ChannelNameSchema (string)

Response

2004XX

Default Response

Body

application/json

pubnubUid*string

pubnubSubscribeKey*string

pubnubPublishKey*string

pubnubAuthToken*string

channels*array of object

bannedChannels*array of ChannelNameSchema (string)

mutedChannels*array of ChannelNameSchema (string)

defaultChannels*array of object

ttlInMinutes*number

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/social/chat/join', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "channels": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "pubnubUid": "text",
  "pubnubSubscribeKey": "text",
  "pubnubPublishKey": "text",
  "pubnubAuthToken": "text",
  "channels": [
    {
      "name": "text",
      "read": false,
      "write": false,
      "type": "party"
    }
  ],
  "bannedChannels": [
    "text"
  ],
  "mutedChannels": [
    "text"
  ],
  "defaultChannels": [
    {
      "read": false,
      "write": false,
      "type": "party"
    }
  ],
  "ttlInMinutes": 0
}

Removes user from a channel

POSThttp://admin.m2worlds.io/api/social/chat/leave

Authorization

BearerAuth

Header parameters

Body

application/json

channels*array of ChannelNameSchema (string)

Response

2004XX

Default Response

Body

application/json

pubnubUid*string

pubnubSubscribeKey*string

pubnubPublishKey*string

pubnubAuthToken*string

channels*array of object

bannedChannels*array of ChannelNameSchema (string)

mutedChannels*array of ChannelNameSchema (string)

defaultChannels*array of object

ttlInMinutes*number

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/social/chat/leave', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "channels": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "pubnubUid": "text",
  "pubnubSubscribeKey": "text",
  "pubnubPublishKey": "text",
  "pubnubAuthToken": "text",
  "channels": [
    {
      "name": "text",
      "read": false,
      "write": false,
      "type": "party"
    }
  ],
  "bannedChannels": [
    "text"
  ],
  "mutedChannels": [
    "text"
  ],
  "defaultChannels": [
    {
      "read": false,
      "write": false,
      "type": "party"
    }
  ],
  "ttlInMinutes": 0
}

Authenticates user with pubnub channels

POSThttp://admin.m2worlds.io/api/social/chat/auth

Authorization

BearerAuth

Header parameters

Response

2004XX

Default Response

Body

application/json

pubnubUid*string

pubnubSubscribeKey*string

pubnubPublishKey*string

pubnubAuthToken*string

channels*array of object

bannedChannels*array of ChannelNameSchema (string)

mutedChannels*array of ChannelNameSchema (string)

defaultChannels*array of object

ttlInMinutes*number

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/social/chat/auth', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "pubnubUid": "text",
  "pubnubSubscribeKey": "text",
  "pubnubPublishKey": "text",
  "pubnubAuthToken": "text",
  "channels": [
    {
      "name": "text",
      "read": false,
      "write": false,
      "type": "party"
    }
  ],
  "bannedChannels": [
    "text"
  ],
  "mutedChannels": [
    "text"
  ],
  "defaultChannels": [
    {
      "read": false,
      "write": false,
      "type": "party"
    }
  ],
  "ttlInMinutes": 0
}

Deletes messages from a channel

DELETEhttp://admin.m2worlds.io/api/social/chat/messages

Authorization

BearerAuth

Header parameters

Body

application/json

channels*array of ChannelNameSchema (string)

Response

4XX

Default Response

Body

application/json

error*string

HTTP error message

codestring

Fastify error code

message*string

User error message

statusCode*number

HTTP status code

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/social/chat/messages', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "channels": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Deletes members from a channel

DELETEhttp://admin.m2worlds.io/api/social/chat/members

Authorization

BearerAuth

Header parameters

Body

application/json

channels*array of ChannelNameSchema (string)

Response

4XX

Default Response

Body

application/json

error*string

HTTP error message

codestring

Fastify error code

message*string

User error message

statusCode*number

HTTP status code

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/social/chat/members', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "channels": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Social Service health check

GEThttp://admin.m2worlds.io/api/social/healthz

Response

200

Provides information about the service status.

Body

application/json

string

Provides information about the service status.

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/social/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"