Skip to main content
Module

x/periskope_maytapi_deno/index.ts>GroupChatOperationsApi

periskope-org/maytapi-deno
Latest
class GroupChatOperationsApi
import { GroupChatOperationsApi } from "https://deno.land/x/periskope_maytapi_deno@v1.4.0/index.ts";

Constructors

new
GroupChatOperationsApi(
configuration: Configuration,
requestFactory?: GroupChatOperationsApiRequestFactory,
responseProcessor?: GroupChatOperationsApiResponseProcessor,
)

Properties

private
api: ObservableGroupChatOperationsApi

Methods

phoneIdCreateGroupPost(
phoneId: string,
phoneIdCreateGroupPostRequest: PhoneIdCreateGroupPostRequest,
_options?: Configuration,
): Promise<PhoneIdCreateGroupPost200Response>

Sets the option for getting the acknowledge messages from the webhook to true or false.

phoneIdGetGroupsConversationIdGet(
phoneId: string,
conversationId: string,
invite?: boolean,
_options?: Configuration,
): Promise<PhoneIdCreateGroupPost200Response>

Get a conversation info.

phoneIdGetGroupsGet(
phoneId: string,
full?: boolean,
sort?: boolean,
invite?: boolean,
page?: number,
_options?: Configuration,
): Promise<PhoneIdGetGroupsGet200Response>

Get conversations list.

phoneIdGroupAddPost(
phoneId: string,
phoneIdGroupAddPostRequest: PhoneIdGroupAddPostRequest,
_options?: Configuration,
): Promise<JustSuccess>

Add a participant to a group conversation. To learn conversation_id you can use /getGroups endpoint.

phoneIdGroupConfigPost(
phoneId: string,
phoneIdGroupConfigPostRequest: PhoneIdGroupConfigPostRequest,
_options?: Configuration,
): Promise<PhoneIdGroupConfigPost200Response>

Change config of a group conversation. To learn conversation_id you can use /getGroups endpoint. You can change who can edit group info(edit), can send message(send) and disappearing messages enabled(disappear). For edit and send config you can use values "admins" or "all". Disappear only accepts true/false values. Config values are optional. If you want to only change a config you should only use that config's key in request body.

phoneIdGroupDemotePost(
phoneId: string,
phoneIdGroupAddPostRequest: PhoneIdGroupAddPostRequest,
_options?: Configuration,
): Promise<JustSuccess>

Demote a participant in a group conversation. To learn conversation_id you can use /getGroups endpoint.

phoneIdGroupPromotePost(
phoneId: string,
phoneIdGroupAddPostRequest: PhoneIdGroupAddPostRequest,
_options?: Configuration,
): Promise<JustSuccess>

Promote a participant in a group conversation. To learn conversation_id you can use /getGroups endpoint.

phoneIdGroupRemovePost(
phoneId: string,
phoneIdGroupAddPostRequest: PhoneIdGroupAddPostRequest,
_options?: Configuration,
): Promise<JustSuccess>

Remove a participant from a group conversation. To learn conversation_id you can use /getGroups endpoint.

phoneIdLeaveGroupPost(
phoneId: string,
phoneIdLeaveGroupPostRequest: PhoneIdLeaveGroupPostRequest,
_options?: Configuration,
): Promise<PhoneIdLeaveGroupPost200Response>

You can leave the group you want with the help of this endpoint.

phoneIdSetProfileImagePost(
phoneId: string,
phoneIdSetProfileImagePostRequest: PhoneIdSetProfileImagePostRequest,
_options?: Configuration,
): Promise<JustSuccess>

Change profile picture of a group conversation or yourself. To change profile picture of yourself you need to leave the conversation_id blank. You need to use square images for better view. We suggest 512x512 images.