yxsdk_rq

Documentation

Index

• type AccidsRq
• type MessageAttachRq
• type MessageBatchRq
• type MessageRq

Types

type AccidsRq

type AccidsRq struct {
	Accids []string `json:"accids"`
}

type MessageAttachRq

type MessageAttachRq struct {
	FromAccid   string   `form:"fromAccid"`   // 发送者accid，用户帐号，最大32字符， 必须保证一个APP内唯一
	ToAccids    []string `form:"toAccids"`    // ["aaa","bbb"]（JSONArray对应的accid，如果解析出错，会报414错误），限500人
	Attach      string   `form:"attach"`      //自定义通知内容，第三方组装的字符串，建议是JSON串，最大长度4096字符
	PushContent string   `form:"pushcontent"` //推送文案，android以此为推送显示文案；ios若未填写payload，显示文案以pushcontent为准。超过500字符后，会对文本进行截断
	Payload     string   `form:"payload"`     //iOS推送对应的payload,必须是JSON,不能超过2k字符
	Sound       string   `form:"sound"`       //如果有指定推送，此属性指定为客户端本地的声音文件名，长度不要超过30个字符，如果不指定，会使用默认声音
	Save        int      `form:"save"`        //1表示只发在线，2表示会存离线，其他会报414错误。默认会存离线
	Option      string   `form:"option"`
}

type MessageBatchRq

type MessageBatchRq struct {
	FromAccid   string   `form:"fromAccid"`   // 发送者accid，用户帐号，最大32字符， 必须保证一个APP内唯一
	ToAccids    []string `form:"toAccids"`    // ["aaa","bbb"]（JSONArray对应的accid，如果解析出错，会报414错误），限500人
	Type        int      `form:"type"`        //0 表示文本消息, 1 表示图片， 2 表示语音， 3 表示视频， 4 表示地理位置信息， 6 表示文件， 100 自定义消息类型（特别注意，对于未对接易盾反垃圾功能的应用，该类型的消息不会提交反垃圾系统检测）
	Body        string   `form:"body"`        //请参考下方消息示例说明中对应消息的body字段， 最大长度5000字符，为一个JSON串
	ReturnMsgid bool     `form:"returnMsgid"` //false：不返回消息ID（默认值） true：返回消息ID（toAccids包含的账号数量不可以超过100个）
	Payload     string   `form:"payload"`     //ios 推送对应的payload,必须是JSON,不能超过2k字符
	Pushcontent string   `form:"pushcontent"` //ios推送内容，不超过500字符，option选项中允许推送（push=true），此字段可以指定推送内容
	Option      string   `form:"option"`
}

type MessageRq

type MessageRq struct {
	From        string `form:"from"` // 发送者accid，用户帐号，最大32字符， 必须保证一个APP内唯一
	To          string `form:"to"`   // ope==0是表示accid即用户id，ope==1表示tid即群id
	Ope         int    `form:"ope"`  //0：点对点个人消息，1：群消息（高级群），其他返回414
	Type        int    `form:"type"` //0 表示文本消息, 1 表示图片， 2 表示语音， 3 表示视频， 4 表示地理位置信息， 6 表示文件， 100 自定义消息类型（特别注意，对于未对接易盾反垃圾功能的应用，该类型的消息不会提交反垃圾系统检测）
	Body        string `form:"body"` //请参考下方消息示例说明中对应消息的body字段， 最大长度5000字符，为一个JSON串
	Ext         string `form:"ext"`
	Payload     string `form:"payload"`     //ios 推送对应的payload,必须是JSON,不能超过2k字符
	Pushcontent string `form:"pushcontent"` //ios推送内容，不超过500字符，option选项中允许推送（push=true），此字段可以指定推送内容
	Option      string `form:"option"`
}