{"openapi":"3.0.0","paths":{"/api/openapi/v1/sms/messages":{"post":{"operationId":"OpenApiController_sendMessage","parameters":[{"name":"X-Signature","in":"header","description":"HMAC-SHA256小写十六进制。方法、路径（不含query）、时间戳、nonce以LF分隔；GET末尾无LF，POST追加LF及原始UTF-8正文，不计算正文摘要。","required":true,"schema":{"type":"string"}},{"name":"X-Nonce","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-App-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiSendMessageDto"}}}},"responses":{"202":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiSendMessageResponseDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"413":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"415":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}}},"summary":"发送单条短信","tags":["client-open-api-v1"]}},"/api/openapi/v1/sms/messages/{messageId}":{"get":{"operationId":"OpenApiController_getMessage","parameters":[{"name":"X-Signature","in":"header","description":"HMAC-SHA256小写十六进制。方法、路径（不含query）、时间戳、nonce以LF分隔；GET末尾无LF，POST追加LF及原始UTF-8正文，不计算正文摘要。","required":true,"schema":{"type":"string"}},{"name":"X-Nonce","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-App-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"messageId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiMessageDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"413":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"415":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}}},"summary":"查询短信状态","tags":["client-open-api-v1"]}},"/api/openapi/v1/sms/uplinks":{"get":{"operationId":"OpenApiController_listUplinks","parameters":[{"name":"X-Signature","in":"header","description":"HMAC-SHA256小写十六进制。方法、路径（不含query）、时间戳、nonce以LF分隔；GET末尾无LF，POST追加LF及原始UTF-8正文，不计算正文摘要。","required":true,"schema":{"type":"string"}},{"name":"X-Nonce","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-App-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"cursor","required":false,"in":"query","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"integer","minimum":1,"default":50},"description":"按当前应用maxPageSize裁剪"},{"name":"keyword","required":false,"in":"query","schema":{"type":"string"}},{"name":"accessNumber","required":false,"in":"query","schema":{"type":"string"}},{"name":"mobile","required":false,"in":"query","schema":{"type":"string"}},{"name":"endTime","required":false,"in":"query","description":"ISO8601时间，默认当前时间；翻页固定时间范围","schema":{"type":"string"}},{"name":"startTime","required":false,"in":"query","description":"ISO8601时间，默认endTime前24小时","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiUplinksDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"413":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"415":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}}},"summary":"游标分页查询上行短信","tags":["client-open-api-v1"]}},"/api/openapi/v1/sms/uplinks/{uplinkId}":{"get":{"operationId":"OpenApiController_getUplink","parameters":[{"name":"X-Signature","in":"header","description":"HMAC-SHA256小写十六进制。方法、路径（不含query）、时间戳、nonce以LF分隔；GET末尾无LF，POST追加LF及原始UTF-8正文，不计算正文摘要。","required":true,"schema":{"type":"string"}},{"name":"X-Nonce","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Timestamp","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-App-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"uplinkId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiUplinkDetailDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"413":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"415":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiProblemDto"}}}}},"summary":"查询上行短信详情","tags":["client-open-api-v1"]}}},"info":{"title":"聆界短信平台 HTTP 客户接口","description":"单条短信发送、短信状态查询、上行短信查询及回调验签接口","version":"1.0.0","contact":{}},"tags":[],"servers":[],"components":{"schemas":{"OpenApiProblemDto":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"number"},"code":{"type":"string"},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code","detail","requestId"]},"OpenApiReceiptDataDto":{"type":"object","properties":{"messageId":{"type":"string"},"gatewayMessageId":{"type":"string","nullable":true},"phoneNumber":{"type":"string"},"receiptStatus":{"type":"string"},"rawStatus":{"type":"string","nullable":true},"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"deliveredAt":{"type":"string","format":"date-time","nullable":true}},"required":["messageId","phoneNumber","receiptStatus"]},"OpenApiReceiptEventDto":{"type":"object","properties":{"eventId":{"type":"string"},"eventType":{"type":"string","enum":["receipt"]},"occurredAt":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/OpenApiReceiptDataDto"}},"required":["eventId","eventType","occurredAt","data"]},"OpenApiUplinkDataDto":{"type":"object","properties":{"applicationId":{"type":"string"},"uplinkMessageId":{"type":"string"},"messageId":{"type":"string","nullable":true},"phoneNumber":{"type":"string"},"destId":{"type":"string"},"content":{"type":"string"},"receivedAt":{"type":"string","format":"date-time"},"manualClaim":{"type":"boolean"}},"required":["applicationId","uplinkMessageId","phoneNumber","destId","content","receivedAt"]},"OpenApiUplinkEventDto":{"type":"object","properties":{"eventId":{"type":"string"},"eventType":{"type":"string","enum":["uplink"]},"occurredAt":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/OpenApiUplinkDataDto"}},"required":["eventId","eventType","occurredAt","data"]},"OpenApiSendMessageDto":{"type":"object","properties":{"mobile":{"type":"string","example":"13800138000","description":"中国大陆手机号"},"content":{"type":"string","example":"【示例签名】您的验证码是123456，5分钟内有效。","description":"完整短信正文；后端自动识别已审核签名、模板及变量值，不接受内部签名或模板 ID"},"clientMessageId":{"type":"string","nullable":true,"example":"order-20260720-0001","maxLength":128}},"required":["mobile","content"]},"OpenApiSendMessageResponseDto":{"type":"object","properties":{"code":{"type":"string","example":"ACCEPTED"},"requestId":{"type":"string","example":"req_7e9a7d85-26df-4cc4-a2af-b61cb46c5cf6"},"messageId":{"type":"string","example":"MSG-7e9a7d85-26df-4cc4-a2af-b61cb46c5cf6"},"clientMessageId":{"type":"string","example":"order-20260720-0001","nullable":true},"status":{"type":"string","example":"queued"},"acceptedAt":{"type":"string","example":"2026-07-20T08:00:00.000Z"}},"required":["code","requestId","messageId","clientMessageId","status","acceptedAt"]},"OpenApiMessageDto":{"type":"object","properties":{"messageId":{"type":"string"},"clientMessageId":{"type":"string","nullable":true},"phoneNumber":{"type":"string"},"status":{"type":"string"},"submitStatus":{"type":"string"},"receiptStatus":{"type":"string"},"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"queuedAt":{"type":"string","format":"date-time"},"submittedAt":{"type":"string","format":"date-time","nullable":true},"deliveredAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time"}},"required":["messageId","clientMessageId","phoneNumber","status","submitStatus","receiptStatus","errorCode","errorMessage","queuedAt","submittedAt","deliveredAt","updatedAt"]},"OpenApiUplinkDto":{"type":"object","properties":{"id":{"type":"string"},"messageId":{"type":"string","nullable":true},"phoneNumber":{"type":"string"},"destId":{"type":"string"},"content":{"type":"string"},"receivedAt":{"type":"string","format":"date-time"}},"required":["id","messageId","phoneNumber","destId","content","receivedAt"]},"OpenApiUplinksDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OpenApiUplinkDto"}},"nextCursor":{"type":"string","nullable":true}},"required":["items","nextCursor"]},"OpenApiUplinkDetailDto":{"type":"object","properties":{"id":{"type":"string"},"messageId":{"type":"string","nullable":true},"phoneNumber":{"type":"string"},"destId":{"type":"string"},"content":{"type":"string"},"receivedAt":{"type":"string","format":"date-time"},"tenantId":{"type":"string"},"applicationId":{"type":"string"}},"required":["id","messageId","phoneNumber","destId","content","receivedAt","tenantId","applicationId"]},"ClientHttpCredentialDto":{"type":"object","properties":{}},"ClientWebhookDto":{"type":"object","properties":{}}}}}