nexconn-server-sdk-go

OpenAPI specification aligned with the current Nexconn public documentation, PDF source documents, and generated SDK requirements.

Chat Growth Credit — Build with Nexconn Chat and explore full capabilities free up to 10,000 MAU. View the offer details →

Overview

• API version: 0.1.1
• Package version: 0.1.1
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

The module is hosted on GitHub at https://github.com/NexconnAI-Dev/nexconn-server-sdk-go.

From your module root (next to go.mod), add the dependency:

go get github.com/NexconnAI-Dev/nexconn-server-sdk-go@latest

Or add a require github.com/NexconnAI-Dev/nexconn-server-sdk-go v… line to go.mod and run go mod tidy. Prefer a release tag instead of @latest when tags exist (for example go get github.com/NexconnAI-Dev/nexconn-server-sdk-go@v0.1.0).

Import:

import ncsdk "github.com/NexconnAI-Dev/nexconn-server-sdk-go"

Quick Start

The example below uses the SDK's built-in signing support to inject App-Key / Nonce / Timestamp / Signature / X-Request-ID automatically.

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	ncsdk "github.com/NexconnAI-Dev/nexconn-server-sdk-go"
)

func main() {
	cfg := ncsdk.NewConfiguration()
	cfg.SetNexconnCredentials(
		os.Getenv("NEXCONN_APP_KEY"),
		os.Getenv("NEXCONN_APP_SECRET"),
	)
	if err := cfg.SetPrimaryBackupDomains(
		os.Getenv("NEXCONN_PRIMARY_API_DOMAIN"),
		os.Getenv("NEXCONN_SECONDARY_API_DOMAIN"),
	); err != nil {
		log.Fatalf("configure domains failed: %v", err)
	}

	// Optional: override the default nonce generator
	// cfg.SetNonceGenerator(func() string { return "custom-nonce" })

	// cfg.SetErrorSwitchingThreshold(1)

	client := ncsdk.NewAPIClient(cfg)
	ctx := context.Background()

	req := ncsdk.NewAccessTokenIssueRequest("user_123", "Alice")
	req.SetAvatarUrl("https://example.com/avatar.png")

	resp, httpResp, err := client.UserManagementAPI.
		IssueAccessToken(ctx).
		AccessTokenIssueRequest(*req).
		Execute()
	if err != nil {
		log.Fatalf("issue token failed: %v", err)
	}

	fmt.Println(httpResp.Status)
	fmt.Printf("%+v\n", resp)
}

Error Handling

API errors are returned as *GenericOpenAPIError values. The error struct provides methods to access the HTTP status, business error code, and error message parsed from the response body.

import (
	"errors"
	"fmt"

	ncsdk "github.com/NexconnAI-Dev/nexconn-server-sdk-go"
)

resp, httpResp, err := client.GroupChannelManagementAPI.
	CreateGroup(ctx).
	GroupChannelCreateRequest(req).
	Execute()
if err != nil {
	var apiErr *ncsdk.GenericOpenAPIError
	if errors.As(err, &apiErr) {
		fmt.Printf("HTTP %d: errorCode=%d, errorMessage=%s\n",
			apiErr.HttpStatus(), apiErr.ErrorCode(), apiErr.ErrorMessage())

		switch {
		case apiErr.IsBadRequest():
			// HTTP 400 — invalid parameters
		case apiErr.IsUnauthorized():
			// HTTP 401 — check your AppKey / AppSecret
		case apiErr.IsForbidden():
			// HTTP 403 — permission denied
		case apiErr.IsNotFound():
			// HTTP 404 — resource not found
		case apiErr.IsConflict():
			// HTTP 409 — resource already exists
		case apiErr.IsTooManyRequests():
			// HTTP 429 — rate limited, retry later
		case apiErr.IsServerError():
			// HTTP 5xx — server error, may retry
		}
	}
}

GenericOpenAPIError provides the following methods:

Method	Description
HttpStatus()	HTTP status code
ErrorCode()	Business error code from response body code field (-1 if unparseable)
ErrorMessage()	Business error message from response body errorMessage field
Body()	Raw response body bytes
Error()	HTTP status text
IsBadRequest()	true if HTTP 400
IsUnauthorized()	true if HTTP 401
IsForbidden()	true if HTTP 403
IsNotFound()	true if HTTP 404
IsConflict()	true if HTTP 409
IsTooManyRequests()	true if HTTP 429
IsServerError()	true if HTTP 5xx

Features

• Automatic Nexconn request signing when SetNexconnCredentials() is configured
• Built-in multi-domain failover support via SetPrimaryBackupDomains()
• Default User-Agent: ncsdk/0.1.1
• Automatic X-Request-ID generation

Configuration of Server URL

The SDK does not embed any default API domain. You must call SetPrimaryBackupDomains() before sending requests.

Select Server Configuration

For using other server than the one defined on index 0 set context value ncsdk.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ncsdk.ContextServerIndex, 1)

Documentation for API Endpoints

All requests use the primary/backup domains configured by the caller.

Class	Method	HTTP request	Description
ChannelManagementAPI	AddTagToChannels	Post /v4/channel/tag/add	Add tag to channel
ChannelManagementAPI	AddUserChannelTags	Post /v4/user/channel/tag/add	Add user channel tag
ChannelManagementAPI	GetChannelAttribute	Post /v4/channel/attribute/get	Get channel attributes
ChannelManagementAPI	GetChannelPushNotification	Post /v4/channel/push/get	Get channel DND
ChannelManagementAPI	GetChannelTypeNotification	Post /v4/channel-type/push/get	Get DND by channel type
ChannelManagementAPI	ListChannelsByTag	Post /v4/channel/tag/list	Get channels by tag
ChannelManagementAPI	ListUserChannelTags	Post /v4/user/channel/tag/list	List user channel tags
ChannelManagementAPI	RemoveTagFromChannels	Post /v4/channel/tag/delete	Remove tag from channel
ChannelManagementAPI	RemoveUserChannelTags	Post /v4/user/channel/tag/remove	Remove user channel tag
ChannelManagementAPI	SetChannelPin	Post /v4/channel/pin/set	Pin a channel
ChannelManagementAPI	SetChannelPushNotification	Post /v4/channel/push/set	Set channel DND
ChannelManagementAPI	SetChannelTypeNotification	Post /v4/channel-type/push/set	Set DND by channel type
CommunityChannelManagementAPI	AddCommunityChannelUserGroupUsers	Post /v4/community-channel/user-group/user/add	Add community channel user group users
CommunityChannelManagementAPI	AddCommunityChannelUserGroups	Post /v4/community-channel/user-group/add	Add community channel user groups
CommunityChannelManagementAPI	AddPrivateSubchannelMembers	Post /v4/community-channel/private-subchannel/member/add	Add private subchannel members
CommunityChannelManagementAPI	BindCommunityChannelUserGroup	Post /v4/community-channel/channel/user-group/bind	Bind community channel user group
CommunityChannelManagementAPI	CheckCommunityChannelMemberExist	Post /v4/community-channel/member/exist	Check community channel member exist
CommunityChannelManagementAPI	CreateCommunityChannel	Post /v4/community-channel/create	Create community channel
CommunityChannelManagementAPI	CreateCommunitySubchannel	Post /v4/community-channel/subchannel/create	Create community subchannel
CommunityChannelManagementAPI	DeleteCommunitySubchannel	Post /v4/community-channel/subchannel/delete	Delete community subchannel
CommunityChannelManagementAPI	DismissCommunityChannel	Post /v4/community-channel/dismiss	Dismiss community channel
CommunityChannelManagementAPI	JoinCommunityChannel	Post /v4/community-channel/join	Join community channel
CommunityChannelManagementAPI	ListCommunityChannelHistoryMessages	Post /v4/community-channel/history-message/list	List community-channel history messages
CommunityChannelManagementAPI	ListCommunityChannelSubchannelUserGroups	Post /v4/community-channel/channel/user-group/list	List community channel subchannel user groups
CommunityChannelManagementAPI	ListCommunityChannelUserGroupSubchannels	Post /v4/community-channel/user-group/subchannel/list	List community channel user group subchannels
CommunityChannelManagementAPI	ListCommunityChannelUserGroups	Post /v4/community-channel/user-group/list	List community channel user groups
CommunityChannelManagementAPI	ListCommunityChannelUserUserGroups	Post /v4/community-channel/user/user-group/list	List community channel user user groups
CommunityChannelManagementAPI	ListCommunitySubchannels	Post /v4/community-channel/subchannel/list	List community subchannels
CommunityChannelManagementAPI	ListCommunityUserSubchannels	Post /v4/community-channel/user/subchannel/list	List community user subchannels
CommunityChannelManagementAPI	ListPrivateSubchannelMembers	Post /v4/community-channel/private-subchannel/member/list	List private subchannel members
CommunityChannelManagementAPI	QuitCommunityChannel	Post /v4/community-channel/leave	Leave community channel
CommunityChannelManagementAPI	RemoveCommunityChannelUserGroupUsers	Post /v4/community-channel/user-group/user/remove	Remove community channel user group users
CommunityChannelManagementAPI	RemoveCommunityChannelUserGroups	Post /v4/community-channel/user-group/remove	Delete community channel user groups
CommunityChannelManagementAPI	RemovePrivateSubchannelMembers	Post /v4/community-channel/private-subchannel/member/remove	Remove private subchannel members
CommunityChannelManagementAPI	UnbindCommunityChannelUserGroup	Post /v4/community-channel/channel/user-group/unbind	Unbind community channel user group
CommunityChannelManagementAPI	UpdateCommunityChannelInfo	Post /v4/community-channel/update	Update community channel info
CommunityChannelManagementAPI	UpdateCommunitySubchannelType	Post /v4/community-channel/subchannel-type/update	Update community subchannel type
CommunityChannelModerationAPI	AddCommunityChannelAllowedSenderList	Post /v4/community-channel/allowed-sender-list/add	Add community channel allowed sender list
CommunityChannelModerationAPI	AddCommunityChannelMutedUsers	Post /v4/community-channel/mute-list/add	Add community-channel muted users
CommunityChannelModerationAPI	GetCommunityChannelFreezeList	Post /v4/community-channel/freeze-list/get	Get community channel freeze status
CommunityChannelModerationAPI	ListCommunityChannelAllowedSenderList	Post /v4/community-channel/allowed-sender-list/get	List community channel allowed sender list
CommunityChannelModerationAPI	ListCommunityChannelMutedUsers	Post /v4/community-channel/mute-list/get	List community-channel muted users
CommunityChannelModerationAPI	RemoveCommunityChannelAllowedSenderList	Post /v4/community-channel/allowed-sender-list/remove	Remove community channel allowed sender list
CommunityChannelModerationAPI	RemoveCommunityChannelMutedUsers	Post /v4/community-channel/mute-list/remove	Remove community-channel muted users
CommunityChannelModerationAPI	SetCommunityChannelFreezeList	Post /v4/community-channel/freeze-list/set	Set community channel freeze list
FriendshipAPI	AddFriend	Post /v4/friend/add	Add friend
FriendshipAPI	GetFriendPermission	Post /v4/friend/permission/get	Get friend permission
FriendshipAPI	GetFriendRelationships	Post /v4/friend/relationship/get	Get friend relationships
FriendshipAPI	ListFriends	Post /v4/friend/list	List friends
FriendshipAPI	RemoveAllFriends	Post /v4/friend/remove-all	Clean all friends
FriendshipAPI	RemoveFriends	Post /v4/friend/remove	Delete friends
FriendshipAPI	SetFriendPermission	Post /v4/friend/permission/set	Set friend permission
FriendshipAPI	SetFriendProfile	Post /v4/friend/profile/set	Set friend profile
GroupChannelManagementAPI	AddGroupChannelAdmins	Post /v4/group-channel/admin/add	Add group admins
GroupChannelManagementAPI	AddGroupChannelMemberFavorites	Post /v4/group-channel/member/favorites/add	Add favorite group members
GroupChannelManagementAPI	BatchGetGroupChannelMembers	Post /v4/group-channel/member/batch/get	Get specific group members
GroupChannelManagementAPI	BatchGetGroupChannelProfiles	Post /v4/group-channel/profile/list	List group profiles
GroupChannelManagementAPI	CreateGroupChannel	Post /v4/group-channel/create	Create a group
GroupChannelManagementAPI	DeleteGroupChannelAlias	Post /v4/group-channel/alias/delete	Delete group alias
GroupChannelManagementAPI	DismissGroupChannel	Post /v4/group-channel/dismiss	Dismiss a group
GroupChannelManagementAPI	GetGroupChannelAlias	Post /v4/group-channel/alias/get	Get group alias
GroupChannelManagementAPI	JoinGroupChannel	Post /v4/group-channel/join	Join a group
GroupChannelManagementAPI	KickUserFromAllGroupChannels	Post /v4/group-channel/member/kickout-all	Remove a user from all groups
GroupChannelManagementAPI	ListGroupChannelMemberFavorites	Post /v4/group-channel/member/favorites/list	List favorite group members
GroupChannelManagementAPI	ListGroupChannelMembers	Post /v4/group-channel/member/list	Query group members
GroupChannelManagementAPI	ListGroupChannels	Post /v4/group-channel/list	List group channels
GroupChannelManagementAPI	ListUserJoinedGroupChannels	Post /v4/group-channel/joined/list	Query user's groups
GroupChannelManagementAPI	QuitGroupChannel	Post /v4/group-channel/leave	Leave a group
GroupChannelManagementAPI	RemoveGroupChannelAdmins	Post /v4/group-channel/admin/remove	Remove group admins
GroupChannelManagementAPI	RemoveGroupChannelMemberFavorites	Post /v4/group-channel/member/favorites/remove	Remove favorite group members
GroupChannelManagementAPI	SetGroupChannelAlias	Post /v4/group-channel/alias/set	Set group alias
GroupChannelManagementAPI	SetGroupChannelMember	Post /v4/group-channel/member/set	Set group member profile
GroupChannelManagementAPI	TransferGroupChannelOwner	Post /v4/group-channel/transfer/owner	Transfer group ownership
GroupChannelManagementAPI	UpdateGroupChannelProfile	Post /v4/group-channel/profile/update	Update group info
GroupChannelModerationAPI	AddGroupChannelAllowedSenderList	Post /v4/group-channel/allowed-sender-list/add	Add to allowed senders list
GroupChannelModerationAPI	AddGroupChannelFreezeList	Post /v4/group-channel/freeze-list/add	Freeze a group
GroupChannelModerationAPI	AddGroupChannelUserMuteList	Post /v4/group-channel/user/mute-list/add	Mute a group member
GroupChannelModerationAPI	GetGroupChannelAllowedSenderList	Post /v4/group-channel/allowed-sender-list/get	Query allowed senders list
GroupChannelModerationAPI	GetGroupChannelFreezeList	Post /v4/group-channel/freeze-list/get	Query group freeze status
GroupChannelModerationAPI	GetGroupChannelUserMuteList	Post /v4/group-channel/user/mute-list/get	List muted group members
GroupChannelModerationAPI	RemoveGroupChannelAllowedSenderList	Post /v4/group-channel/allowed-sender-list/remove	Remove from allowed senders list
GroupChannelModerationAPI	RemoveGroupChannelFreezeList	Post /v4/group-channel/freeze-list/remove	Unfreeze a group
GroupChannelModerationAPI	RemoveGroupChannelUserMuteList	Post /v4/group-channel/user/mute-list/remove	Unmute a group member
MessageManagementAPI	BroadcastOpenChannelMessage	Post /v4/open-channel/message/broadcast	Broadcast to all open channels
MessageManagementAPI	DeleteChannelMessageHistory	Post /v4/channel/message/history/delete	Delete server-side channel message history
MessageManagementAPI	DeleteChannelTypeMessageMetadata	Post /v4/channel-type/message/metadata/delete	Delete message metadata
MessageManagementAPI	DeleteCommunityChannelMessageMetadata	Post /v4/community-channel/message/metadata/delete	Delete community-channel message metadata keys
MessageManagementAPI	DeleteMessage	Post /v4/message/delete	Delete a message (recall)
MessageManagementAPI	ListChannelTypeMessageMetadata	Post /v4/channel-type/message/metadata/list	Get message metadata
MessageManagementAPI	ListCommunityChannelMessageMetadata	Post /v4/community-channel/message/metadata/list	List community-channel message metadata
MessageManagementAPI	SendCommunityChannelMessage	Post /v4/community-channel/message/send	Send a community channel message
MessageManagementAPI	SendDirectChannelMessage	Post /v4/direct-channel/message/send	Send a direct message
MessageManagementAPI	SendDirectChannelStreamMessage	Post /v4/direct-channel/message/stream/send	Send a direct channel stream message
MessageManagementAPI	SendGroupChannelMessage	Post /v4/group-channel/message/send	Send a group message
MessageManagementAPI	SendGroupChannelStreamMessage	Post /v4/group-channel/message/stream/send	Send a group channel stream message
MessageManagementAPI	SendOpenChannelMessage	Post /v4/open-channel/message/send	Send an open channel message
MessageManagementAPI	SetChannelTypeMessageMetadata	Post /v4/channel-type/message/metadata/set	Set message metadata
MessageManagementAPI	SetCommunityChannelMessageMetadata	Post /v4/community-channel/message/metadata/set	Set community-channel message metadata
MessageManagementAPI	UpdateCommunityChannelMessage	Post /v4/community-channel/message/update	Update community-channel message
MessageManagementAPI	UpdateDirectChannelMessage	Post /v4/direct-channel/message/update	Update direct-channel message
MessageManagementAPI	UpdateGroupChannelMessage	Post /v4/group-channel/message/update	Update group-channel message
ModerationAPI	BatchAddProfanityWords	Post /v4/profanity-word/batch/add	Batch add profanity words
ModerationAPI	BatchRemoveProfanityWords	Post /v4/profanity-word/batch/remove	Batch delete profanity words
ModerationAPI	ListProfanityWords	Post /v4/profanity-word/list	List profanity words
ModerationAPI	RemoveProfanityWord	Post /v4/profanity-word/remove	Delete profanity word
OpenChannelManagementAPI	CreateOpenChannel	Post /v4/open-channel/create	Create an open channel
OpenChannelManagementAPI	DestroyOpenChannels	Post /v4/open-channel/destroy	Destroy an open channel
OpenChannelManagementAPI	GetOpenChannel	Post /v4/open-channel/get	Get open channel info
OpenChannelManagementAPI	SetOpenChannelDestroyType	Post /v4/open-channel/destroy-type/set	Set auto-destroy type
OpenChannelMessagePriorityAPI	AddOpenChannelLowPriorityMessageTypeList	Post /v4/open-channel/low-priority-message-type-list/add	Add low-priority message types
OpenChannelMessagePriorityAPI	GetOpenChannelLowPriorityMessageTypeList	Post /v4/open-channel/low-priority-message-type-list/get	Query low-priority message types
OpenChannelMessagePriorityAPI	RemoveOpenChannelLowPriorityMessageTypeList	Post /v4/open-channel/low-priority-message-type-list/remove	Remove low-priority message types
OpenChannelMetadataAPI	BatchGetOpenChannelMetadata	Post /v4/open-channel/metadata/batch/get	Query metadata
OpenChannelMetadataAPI	BatchRemoveOpenChannelMetadata	Post /v4/open-channel/metadata/batch/remove	Batch delete metadata
OpenChannelMetadataAPI	BatchSetOpenChannelMetadata	Post /v4/open-channel/metadata/batch/set	Batch set metadata
OpenChannelParticipantsModerationAPI	AddOpenChannelFreezeList	Post /v4/open-channel/freeze-list/add	Freeze an open channel
OpenChannelParticipantsModerationAPI	AddOpenChannelGlobalMuteList	Post /v4/open-channel/global-mute-list/add	Mute a user globally
OpenChannelParticipantsModerationAPI	AddOpenChannelParticipantAllowedSenderList	Post /v4/open-channel/participant/allowed-sender-list/add	Add to allowed senders list
OpenChannelParticipantsModerationAPI	AddOpenChannelParticipantBanList	Post /v4/open-channel/participant/ban-list/add	Ban a participant
OpenChannelParticipantsModerationAPI	AddOpenChannelParticipantMuteList	Post /v4/open-channel/participant/mute-list/add	Mute a participant
OpenChannelParticipantsModerationAPI	CheckOpenChannelFreeze	Post /v4/open-channel/freeze/check	Check open channel freeze status
OpenChannelParticipantsModerationAPI	CheckOpenChannelParticipantsExist	Post /v4/open-channel/participant/exist	Batch check participants
OpenChannelParticipantsModerationAPI	GetOpenChannelGlobalMuteList	Post /v4/open-channel/global-mute-list/get	List globally muted users
OpenChannelParticipantsModerationAPI	GetOpenChannelParticipantAllowedSenderList	Post /v4/open-channel/participant/allowed-sender-list/get	Query allowed senders list
OpenChannelParticipantsModerationAPI	GetOpenChannelParticipantBanList	Post /v4/open-channel/participant/ban-list/get	List banned participants
OpenChannelParticipantsModerationAPI	GetOpenChannelParticipantMuteList	Post /v4/open-channel/participant/mute-list/get	List muted participants
OpenChannelParticipantsModerationAPI	ListFrozenOpenChannels	Post /v4/open-channel/freeze-list/get	List frozen open channels
OpenChannelParticipantsModerationAPI	ListOpenChannelParticipants	Post /v4/open-channel/participant/list	List participants
OpenChannelParticipantsModerationAPI	RemoveOpenChannelFreezeList	Post /v4/open-channel/freeze-list/remove	Unfreeze an open channel
OpenChannelParticipantsModerationAPI	RemoveOpenChannelGlobalMuteList	Post /v4/open-channel/global-mute-list/remove	Unmute a user globally
OpenChannelParticipantsModerationAPI	RemoveOpenChannelParticipantAllowedSenderList	Post /v4/open-channel/participant/allowed-sender-list/remove	Remove from allowed senders list
OpenChannelParticipantsModerationAPI	RemoveOpenChannelParticipantBanList	Post /v4/open-channel/participant/ban-list/remove	Unban a participant
OpenChannelParticipantsModerationAPI	RemoveOpenChannelParticipantMuteList	Post /v4/open-channel/participant/mute-list/remove	Unmute a participant
OpenChannelPriorityControlsAPI	AddOpenChannelPriorityMessageTypeList	Post /v4/open-channel/priority-message-type-list/add	Add priority message types
OpenChannelPriorityControlsAPI	AddOpenChannelPrioritySenderList	Post /v4/open-channel/priority-sender-list/add	Add priority senders
OpenChannelPriorityControlsAPI	GetOpenChannelPriorityMessageTypeList	Post /v4/open-channel/priority-message-type-list/get	Query priority message types
OpenChannelPriorityControlsAPI	GetOpenChannelPrioritySenderList	Post /v4/open-channel/priority-sender-list/get	Query priority senders
OpenChannelPriorityControlsAPI	RemoveOpenChannelPriorityMessageTypeList	Post /v4/open-channel/priority-message-type-list/remove	Remove priority message types
OpenChannelPriorityControlsAPI	RemoveOpenChannelPrioritySenderList	Post /v4/open-channel/priority-sender-list/remove	Remove priority senders
SystemMessagesAPI	BroadcastMessageOnline	Post /v4/system-channel/message/broadcast-online	Broadcast to online users
SystemMessagesAPI	BroadcastSystemChannelMessage	Post /v4/system-channel/message/broadcast-all	Broadcast to all users (persistent)
SystemMessagesAPI	DeleteBroadcastMessage	Post /v4/system-channel/message/broadcast/delete	Recall broadcast to all users
SystemMessagesAPI	SendSystemChannelMessage	Post /v4/system-channel/message/send	Send a system message
SystemMessagesAPI	SendSystemChannelPushByPackage	Post /v4/system-channel/app-package-users/send	Push by app package name
SystemMessagesAPI	SendSystemChannelPushByTag	Post /v4/system-channel/tagged-users/send	Push to tagged users
UserBlocklistAPI	AddUserBlocklist	Post /v4/user/blocklist/add	Add to blocklist
UserBlocklistAPI	GetUserBlocklist	Post /v4/user/blocklist/get	Get blocklist
UserBlocklistAPI	RemoveUserBlocklist	Post /v4/user/blocklist/remove	Remove from blocklist
UserManagementAPI	BanUsers	Post /v4/user/ban	Ban a user
UserManagementAPI	BatchGetUserTags	Post /v4/user/tag/batch/get	Get user tags
UserManagementAPI	BatchSetUserTags	Post /v4/user/tag/batch/set	Batch set user tags
UserManagementAPI	ExpireAccessToken	Post /v4/auth/access-token/expire	Expire an access token
UserManagementAPI	GetUser	Post /v4/user/get	Get user info
UserManagementAPI	GetUserConnectionStatus	Post /v4/user/connection-status/get	Check user online status
UserManagementAPI	IssueAccessToken	Post /v4/auth/access-token/issue	Register a user
UserManagementAPI	ListBannedUsers	Post /v4/user/ban/list	List banned users
UserManagementAPI	ListChannelTypeMute	Post /v4/channel-type/mute/list	List muted direct channel users
UserManagementAPI	ListSoftDeletedUsers	Post /v4/user/soft-deleted/list	Query soft-deleted users
UserManagementAPI	RestoreUsers	Post /v4/user/restore	Restore a user
UserManagementAPI	SetChannelTypeMute	Post /v4/channel-type/mute/set	Mute a user in direct channels
UserManagementAPI	SoftDeleteUsers	Post /v4/user/soft-delete	Soft-delete a user
UserManagementAPI	UnbanUsers	Post /v4/user/unban	Unban a user
UserManagementAPI	UpdateUser	Post /v4/user/update	Update user info
UserProfileHostingAPI	BatchGetUserProfiles	Post /v4/user/profile/batch/get	Batch get user profiles
UserProfileHostingAPI	DeleteUserProfiles	Post /v4/user/profile/delete	Clear user profiles
UserProfileHostingAPI	ListUserProfiles	Post /v4/user/profile/list	List user profiles
UserProfileHostingAPI	SetUserProfile	Post /v4/user/profile/set	Set user profile

Documentation For Models

• AccessTokenExpireRequest
• AccessTokenIssueRequest
• AccessTokenIssueResponse
• AccessTokenIssueResult
• BannedUser
• ChannelAttributeGetRequest
• ChannelAttributeGetResponse
• ChannelAttributeGetResponseResult
• ChannelAttributeTagItem
• ChannelMessageHistoryDeleteRequest
• ChannelMessageSendResponse
• ChannelMessageSendResponseResult
• ChannelNotificationState
• ChannelPinSetRequest
• ChannelPinState
• ChannelPushGetRequest
• ChannelPushGetResponse
• ChannelPushGetResponseResult
• ChannelPushSetRequest
• ChannelTagAddRequest
• ChannelTagListRequest
• ChannelTagListResponse
• ChannelTagListResponseResult
• ChannelTagRemoveRequest
• ChannelTagTargetItem
• ChannelTypeMessageMetadataDeleteRequest
• ChannelTypeMessageMetadataListRequest
• ChannelTypeMessageMetadataListResponse
• ChannelTypeMessageMetadataListResponseResult
• ChannelTypeMuteListRequest
• ChannelTypeMuteListResponse
• ChannelTypeMuteListResponseResult
• ChannelTypeMuteSetRequest
• ChannelTypeNotificationGetRequest
• ChannelTypeNotificationGetResponse
• ChannelTypeNotificationGetResponseResult
• ChannelTypeNotificationSetRequest
• CodeOnlyResponse
• CommunityChannelAllowedSenderItem
• CommunityChannelAllowedSenderListGetRequest
• CommunityChannelAllowedSenderListGetResponse
• CommunityChannelAllowedSenderListGetResponseResult
• CommunityChannelAllowedSenderListUpdateRequest
• CommunityChannelCreateRequest
• CommunityChannelDismissRequest
• CommunityChannelFreezeListGetRequest
• CommunityChannelFreezeListGetResponse
• CommunityChannelFreezeListGetResponseResult
• CommunityChannelFreezeListSetRequest
• CommunityChannelHistoryMessageListRequest
• CommunityChannelMemberExistResponse
• CommunityChannelMemberExistResponseResult
• CommunityChannelMemberRequest
• CommunityChannelMessageMetadataDeleteRequest
• CommunityChannelMessageMetadataListRequest
• CommunityChannelMessageMetadataListResponse
• CommunityChannelMessageMetadataListResponseResult
• CommunityChannelMessageMetadataSetRequest
• CommunityChannelMessageSendRequest
• CommunityChannelMessageUpdateRequest
• CommunityChannelMuteListAddRequest
• CommunityChannelMuteListGetRequest
• CommunityChannelMuteListGetResponse
• CommunityChannelMuteListGetResponseResult
• CommunityChannelMuteListRemoveRequest
• CommunityChannelMutedMemberItem
• CommunityChannelSubchannelUserGroupListRequest
• CommunityChannelSubchannelUserGroupListResponse
• CommunityChannelSubchannelUserGroupListResponseResult
• CommunityChannelUpdateRequest
• CommunityChannelUserGroupAddRequest
• CommunityChannelUserGroupBindingRequest
• CommunityChannelUserGroupDeleteRequest
• CommunityChannelUserGroupItem
• CommunityChannelUserGroupListRequest
• CommunityChannelUserGroupListResponse
• CommunityChannelUserGroupListResponseResult
• CommunityChannelUserGroupSubchannelListRequest
• CommunityChannelUserGroupSubchannelListResponse
• CommunityChannelUserGroupSubchannelListResponseResult
• CommunityChannelUserGroupUsersRequest
• CommunityChannelUserUserGroupListRequest
• CommunityChannelUserUserGroupListResponse
• CommunityChannelUserUserGroupListResponseResult
• CommunityPrivateSubchannelMemberListRequest
• CommunityPrivateSubchannelMemberListResponse
• CommunityPrivateSubchannelMemberListResponseResult
• CommunityPrivateSubchannelMembersRequest
• CommunitySubchannelCreateRequest
• CommunitySubchannelItem
• CommunitySubchannelKeyRequest
• CommunitySubchannelListRequest
• CommunitySubchannelListResponse
• CommunitySubchannelListResponseResult
• CommunitySubchannelTypeUpdateRequest
• CommunityUserSubchannelListRequest
• CommunityUserSubchannelListResponse
• CommunityUserSubchannelListResponseResult
• DirectChannelMessageSendRequest
• DirectChannelMessageUpdateRequest
• DirectChannelStreamMessageSendRequest
• FriendAddRequest
• FriendCleanRequest
• FriendDeleteRequest
• FriendItem
• FriendListRequest
• FriendListResponse
• FriendListResponseResult
• FriendPermissionGetRequest
• FriendPermissionGetResponse
• FriendPermissionGetResponseResult
• FriendPermissionItem
• FriendPermissionSetRequest
• FriendProfileSetRequest
• FriendRelationshipGetRequest
• FriendRelationshipGetResponse
• FriendRelationshipGetResponseResult
• FriendRelationshipItem
• GroupChannelAdminUsersRequest
• GroupChannelAliasGetRequest
• GroupChannelAliasGetResponse
• GroupChannelAliasGetResponseResult
• GroupChannelAliasSetRequest
• GroupChannelAllowedSenderListGetRequest
• GroupChannelAllowedSenderListGetResponse
• GroupChannelAllowedSenderListGetResponseResult
• GroupChannelAllowedSenderListUpdateRequest
• GroupChannelCreateRequest
• GroupChannelDismissRequest
• GroupChannelFavoriteItem
• GroupChannelFreezeListGetRequest
• GroupChannelFreezeListGetResponse
• GroupChannelFreezeListGetResponseResult
• GroupChannelFreezeListUpdateRequest
• GroupChannelFreezeStatusItem
• GroupChannelJoinRequest
• GroupChannelJoinResponse
• GroupChannelJoinedItem
• GroupChannelJoinedListRequest
• GroupChannelJoinedListResponse
• GroupChannelJoinedListResponseResult
• GroupChannelKickUserFromAllRequest
• GroupChannelListRequest
• GroupChannelListResponse
• GroupChannelListResponseResult
• GroupChannelMemberBatchGetRequest
• GroupChannelMemberBatchGetResponse
• GroupChannelMemberBatchGetResponseResult
• GroupChannelMemberFavoritesListRequest
• GroupChannelMemberFavoritesListResponse
• GroupChannelMemberFavoritesListResponseResult
• GroupChannelMemberFavoritesUpdateRequest
• GroupChannelMemberItem
• GroupChannelMemberListRequest
• GroupChannelMemberListResponse
• GroupChannelMemberListResponseResult
• GroupChannelMemberSetRequest
• GroupChannelMessageSendRequest
• GroupChannelMessageUpdateRequest
• GroupChannelMutedMemberItem
• GroupChannelProfileItem
• GroupChannelProfileListRequest
• GroupChannelProfileListResponse
• GroupChannelProfileListResponseResult
• GroupChannelProfileUpdateRequest
• GroupChannelQuitRequest
• GroupChannelStreamMessageSendRequest
• GroupChannelSummaryItem
• GroupChannelTransferOwnerRequest
• GroupChannelUserMuteListAddRequest
• GroupChannelUserMuteListGetRequest
• GroupChannelUserMuteListGetResponse
• GroupChannelUserMuteListGetResponseResult
• GroupChannelUserMuteListRemoveRequest
• MessageChannelDelivery
• MessageDeleteRequest
• MessageHistoryResponse
• MessageHistoryResponseResult
• MessageMetadataListItem
• MessageMetadataSetRequest
• MessageRecord
• MessageUserDelivery
• OpenChannelAllowedSenderListGetResponse
• OpenChannelAllowedSenderListGetResponseResult
• OpenChannelAllowedSenderListUpdateRequest
• OpenChannelBannedParticipantItem
• OpenChannelBroadcastRequest
• OpenChannelCreateRequest
• OpenChannelDestroyRequest
• OpenChannelDestroyTypeSetRequest
• OpenChannelFreezeCheckRequest
• OpenChannelFreezeCheckResponse
• OpenChannelFreezeCheckResponseResult
• OpenChannelFreezeListGetRequest
• OpenChannelFreezeListGetResponse
• OpenChannelFreezeListGetResponseResult
• OpenChannelFreezeListUpdateRequest
• OpenChannelGetRequest
• OpenChannelGetResponse
• OpenChannelGetResponseResult
• OpenChannelGlobalMuteListAddRequest
• OpenChannelGlobalMuteListRemoveRequest
• OpenChannelLowPriorityMessageTypeListRequest
• OpenChannelMessageSendRequest
• OpenChannelMessageTypeListResponse
• OpenChannelMessageTypeListResponseResult
• OpenChannelMetadataBatchGetRequest
• OpenChannelMetadataBatchGetResponse
• OpenChannelMetadataBatchGetResponseResult
• OpenChannelMetadataBatchRemoveRequest
• OpenChannelMetadataBatchSetRequest
• OpenChannelMetadataEntry
• OpenChannelMutedParticipantItem
• OpenChannelParticipantBanListGetResponse
• OpenChannelParticipantBanListGetResponseResult
• OpenChannelParticipantExistItem
• OpenChannelParticipantExistRequest
• OpenChannelParticipantExistResponse
• OpenChannelParticipantExistResponseResult
• OpenChannelParticipantIdsRequest
• OpenChannelParticipantIdsResponse
• OpenChannelParticipantIdsResponseResult
• OpenChannelParticipantItem
• OpenChannelParticipantListByChannelRequest
• OpenChannelParticipantListRequest
• OpenChannelParticipantListResponse
• OpenChannelParticipantListResponseResult
• OpenChannelParticipantMuteListAddRequest
• OpenChannelParticipantMuteListGetResponse
• OpenChannelParticipantMuteListGetResponseResult
• OpenChannelParticipantMuteListRemoveRequest
• OpenChannelPriorityMessageTypeListRequest
• ProfanityWordBatchAddRequest
• ProfanityWordBatchAddResponse
• ProfanityWordBatchAddResponseResult
• ProfanityWordBatchDeleteRequest
• ProfanityWordDeleteRequest
• ProfanityWordItem
• ProfanityWordListRequest
• ProfanityWordListResponse
• ProfanityWordListResponseResult
• ProfanityWordListedItem
• SingleMessageIdResponse
• SingleMessageIdResponseResult
• StreamMessageContent
• StreamMessageSendResponse
• StreamMessageSendResponseResult
• SystemChannelBroadcastAllRequest
• SystemChannelBroadcastDeleteRequest
• SystemChannelBroadcastOnlineRequest
• SystemChannelMessageSendRequest
• SystemChannelPushAudience
• SystemChannelPushMessage
• SystemChannelPushNotification
• SystemChannelPushRequest
• SystemChannelPushResponse
• SystemChannelPushResponseResult
• UserBanListRequest
• UserBanListResponse
• UserBanListResponseResult
• UserBanRequest
• UserBlocklistAddRequest
• UserBlocklistGetRequest
• UserBlocklistGetResponse
• UserBlocklistGetResponseResult
• UserBlocklistRemoveRequest
• UserChannelTagAddRequest
• UserChannelTagItem
• UserChannelTagListItem
• UserChannelTagListRequest
• UserChannelTagListResponse
• UserChannelTagListResponseResult
• UserChannelTagRemoveRequest
• UserConnectionStatusRequest
• UserConnectionStatusResponse
• UserConnectionStatusResponseResult
• UserGetRequest
• UserGetResponse
• UserGetResult
• UserIdsMax100Request
• UserIdsMax20Request
• UserIdsRequest
• UserMessageSendResponse
• UserMessageSendResponseResult
• UserOperationResponse
• UserOperationResponseResult
• UserProfileBatchGetResponse
• UserProfileBatchGetResponseResult
• UserProfileItem
• UserProfileListItem
• UserProfileListRequest
• UserProfileListResponse
• UserProfileListResponseResult
• UserProfileSetRequest
• UserProfileSetResponse
• UserSoftDeletedListRequest
• UserSoftDeletedListResponse
• UserSoftDeletedListResponseResult
• UserTagBatchGetItem
• UserTagBatchGetRequest
• UserTagBatchGetResponse
• UserTagBatchGetResponseResult
• UserTagBatchSetRequest
• UserUpdateRequest

Documentation For Authorization

Authentication schemes defined for the API:

NexconnSignature

• Type: API key
• API key parameter name: App-Key
• Location: HTTP header

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Package Info

• Repository: https://github.com/NexconnAI-Dev/nexconn-server-sdk-go
• Package version: 0.1.1

License

This project is licensed under the MIT License.