> For the complete documentation index, see [llms.txt](https://developers-apps-in-toss.toss.im/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers-apps-in-toss.toss.im/api/en/push.md). # Push, alerts ## Send message > This API allows partner apps to send notifications or messages to Toss users. A user authentication token is required, and it must include the scope permission to send messages to users. All messages, including test sends, can only be sent after passing copy review approval.\ > \ > \### Business error code\ > \ > The errors below are returned with HTTP 200 and \`resultType: FAIL\` are returned.\ > \ > \| errorCode | Description |\ > \| --------- | ----------------------------------------------------------------------------------------------- |\ > \| \`5004\` | This is an unapproved message template. To send messages, template review approval is required. |\ > \| \`4034\` | There is no workspace, or you don't have permission to access the workspace |\ > \| \`4010\` | Authentication information couldn't be found. |\ > \| \`4095\` | Request limit exceeded. Please try again later. |\ > \ > This API can pass through the error codes of the connected internal system as-is. Undocumented \`errorCode\` should be treated as a failure and \`reason\` Refer to the message.\ > \ > \*\*Request limit\*\*: 15,000 times per minute per app, 10 times per minute per user ```json {"openapi":"3.1.0","info":{"title":"Apps in Toss Partner API","version":"1.0.0"},"tags":[{"description":"This is the API used when partner apps handle messages with Toss users.","name":"push"}],"servers":[{"description":"Operations (for simple login, message sending, Toss Points payout, etc.)","url":"https://apps-in-toss-api.toss.im"}],"security":[{"mutualTLS":[]}],"components":{"securitySchemes":{"mutualTLS":{"description":"This is mTLS authentication based on a client certificate issued to the partner. The mini app is identified by the certificate's CN. For how to issue and manage certificates, [Using the server API](https://developers-apps-in-toss.toss.im/documentation/integration/server-api) please refer to the documentation.","type":"mutualTLS"}},"schemas":{"SendMessageRequest":{"description":"Defines the message to send to the user. It includes which message template to use and the data to put into the template.","properties":{"context":{"additionalProperties":{"type":"object"},"description":"These are the variable values used in the template. For example, values such as the user name or verification code are entered here.","type":"object"},"templateSetCode":{"description":"This is the message template code to use. Enter one of the pre-registered template codes.","type":"string"}},"required":["context","templateSetCode"],"type":"object"},"TossApiSuccessSendMessageResponse":{"description":"This is the success response envelope.","properties":{"resultType":{"description":"This is the processing result. On success, `SUCCESS` it is.","enum":["SUCCESS"],"type":"string"},"success":{"$ref":"#/components/schemas/SendMessageResponse"}},"required":["resultType","success"],"type":"object"},"SendMessageResponse":{"description":"It contains how many messages were sent by channel and detailed information about messages that succeeded or failed.","properties":{"detail":{"$ref":"#/components/schemas/AppendContextResultDetailResponse","description":"This is detailed information about messages that were sent successfully."},"fail":{"$ref":"#/components/schemas/AppendContextResultDetailResponse","description":"This is detailed information about messages that failed to send."},"msgCount":{"description":"This is the total number of messages sent.","format":"int32","type":"integer"},"sentAlimtalkCount":{"description":"This is the number of messages sent via Alimtalk.","format":"int32","type":"integer"},"sentFriendtalkCount":{"description":"This is the number of messages sent via Friend Talk.","format":"int32","type":"integer"},"sentInboxCount":{"description":"This is the number of messages sent via Inbox.","format":"int32","type":"integer"},"sentPushCount":{"description":"This is the number of messages sent via Push.","format":"int32","type":"integer"},"sentSmsCount":{"description":"This is the number of messages sent via SMS.","format":"int32","type":"integer"}},"required":["detail","fail","msgCount","sentAlimtalkCount","sentFriendtalkCount","sentInboxCount","sentPushCount","sentSmsCount"]},"AppendContextResultDetailResponse":{"description":"This is a detailed list of messages sent by channel. You can see which messages succeeded or failed in which channel.","properties":{"sentAlimtalk":{"description":"This is a list of messages sent via Alimtalk.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentFriendtalk":{"description":"This is a list of messages sent via Friend Talk.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentInbox":{"description":"This is a list of messages sent via Inbox.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentPush":{"description":"This is a list of messages sent via Push.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentSms":{"description":"This is a list of messages sent via SMS.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"}},"required":["sentAlimtalk","sentFriendtalk","sentInbox","sentPush","sentSms"]},"SentContentResponse":{"description":"This is information about a single sent message.","properties":{"contentId":{"description":"This is the unique ID of the sent message.","type":"string"},"reachedFailReason":{"description":"If message delivery fails, the reason for failure is included.","type":"string"}},"required":["contentId"]},"TossApiFail":{"description":"This is the failure response envelope. Business errors are returned with HTTP 200, so `resultType` be sure to check it.","properties":{"error":{"$ref":"#/components/schemas/TossApiError"},"resultType":{"description":"This is the processing result. `SUCCESS` Treat all values other than `FAIL` as failure. Generally,","enum":["FAIL","HTTP_TIMEOUT","NETWORK_ERROR","EXECUTION_FAIL","INTERRUPTED","INTERNAL_ERROR"],"type":"string"},"success":{"description":"It is always null on failure."}},"required":["error","resultType"],"type":"object"},"TossApiError":{"description":"This is detailed error information.","properties":{"data":{"description":"Additional error information. When the request limit is exceeded `retryAfterSeconds` is included.","type":"object"},"errorCode":{"description":"This is the error code. Refer to each API's business error code table.","type":"string"},"errorType":{"description":"This is an internal error classification value. For error categorization, `errorCode` use it.","format":"int32","type":"integer"},"reason":{"description":"This is a human-readable error description.","type":"string"},"title":{"description":"This is the error title. It is usually null.","type":"string"}},"required":["errorCode","reason"],"type":"object"},"TossApiValidationFail":{"description":"This is the response when request field validation fails.","properties":{"error":{"$ref":"#/components/schemas/TossApiValidationFailError"},"resultType":{"description":"This is the processing result. `SUCCESS` Treat all values other than `FAIL` as failure. Generally,","enum":["FAIL","HTTP_TIMEOUT","NETWORK_ERROR","EXECUTION_FAIL","INTERRUPTED","INTERNAL_ERROR"],"type":"string"},"success":{"description":"It is always null on failure."}},"required":["error","resultType"],"type":"object"},"TossApiValidationFailError":{"description":"This is detailed error information.","properties":{"data":{"description":"Additional error information. When the request limit is exceeded `retryAfterSeconds` is included.","properties":{"errorDetails":{"description":"This is a detailed list of field-level validation failures.","items":{"$ref":"#/components/schemas/TossApiFieldError"},"type":"array"}},"type":"object"},"errorCode":{"description":"This is the error code. Refer to each API's business error code table.","type":"string"},"errorType":{"description":"This is an internal error classification value. For error categorization, `errorCode` use it.","format":"int32","type":"integer"},"reason":{"description":"This is a human-readable error description.","type":"string"},"title":{"description":"This is the error title. It is usually null.","type":"string"}},"required":["errorCode","reason"],"type":"object"},"TossApiFieldError":{"description":"This is a detailed list of field-level validation failures.","properties":{"field":{"description":"This is the name of the field that failed validation.","type":"string"},"message":{"description":"This is the reason for the validation failure.","type":"string"},"rejectedValue":{"description":"This is a rejected input value."}},"type":"object"}}},"paths":{"/api-partner/v1/apps-in-toss/messenger/send-message":{"post":{"description":"This API allows partner apps to send notifications or messages to Toss users. A user authentication token is required, and it must include the scope permission to send messages to users. All messages, including test sends, can only be sent after passing copy review approval.\n\n### Business error code\n\nThe errors below are returned with HTTP 200 and `resultType: FAIL` are returned.\n\n| errorCode | Description |\n| --------- | ----------------------------------------------------------------------------------------------- |\n| `5004` | This is an unapproved message template. To send messages, template review approval is required. |\n| `4034` | There is no workspace, or you don't have permission to access the workspace |\n| `4010` | Authentication information couldn't be found. |\n| `4095` | Request limit exceeded. Please try again later. |\n\nThis API can pass through the error codes of the connected internal system as-is. Undocumented `errorCode` should be treated as a failure and `reason` Refer to the message.\n\n**Request limit**: 15,000 times per minute per app, 10 times per minute per user","operationId":"sendMessage","parameters":[{"description":"It's a key for authenticating users. [Get user information](https://developers-apps-in-toss.toss.im/documentation/api/toss-login#get-api-partner-v1-apps-in-toss-user-oauth2-login-me) You can obtain it through the API","in":"header","name":"x-toss-user-key","required":false,"schema":{"type":"string"}},{"description":"It's a key for authenticating users. In the Mini App SDK, [User.getAnonymousKey](https://developers-apps-in-toss.toss.im/documentation/sdk/domains-api/user/user.getanonymouskey) you can get it with the function","in":"header","name":"x-anon-key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"description":"Information about the message to send","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"discriminator":{"mapping":{"FAIL":"#/components/schemas/TossApiFail","SUCCESS":"#/components/schemas/TossApiSuccessSendMessageResponse"},"propertyName":"resultType"},"oneOf":[{"$ref":"#/components/schemas/TossApiSuccessSendMessageResponse"},{"$ref":"#/components/schemas/TossApiFail"}]}}},"description":"Message sent successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TossApiValidationFail"}}},"description":"The request body is not in the correct format. `error.data.errorDetails` Check the detailed information for each field below."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TossApiFail"}}},"description":"This is an uncategorized server error. If it keeps failing, contact the partner support channel."}},"summary":"Send message","tags":["push"]}}}} ``` ## Send bulk messages > Send messages in bulk to many users with the same template. Use this when sending at least 50 messages in bulk. You can send up to 2,500 messages per request.\ > \ > \### Business error code\ > \ > The errors below are returned with HTTP 200 and \`resultType: FAIL\` are returned.\ > \ > \| errorCode | Description |\ > \| --------- | ----------------------------------------------------------------------------------------------- |\ > \| \`5004\` | This is an unapproved message template. To send messages, template review approval is required. |\ > \| \`4034\` | There is no workspace, or you don't have permission to access the workspace |\ > \| \`4095\` | Request limit exceeded. Please try again later. |\ > \ > This API can pass through the error codes of the connected internal system as-is. Undocumented \`errorCode\` should be treated as a failure and \`reason\` Refer to the message.\ > \ > \*\*Request limit\*\*: 3,000 times per minute per app ```json {"openapi":"3.1.0","info":{"title":"Apps in Toss Partner API","version":"1.0.0"},"tags":[{"description":"This is the API used when partner apps handle messages with Toss users.","name":"push"}],"servers":[{"description":"Operations (for simple login, message sending, Toss Points payout, etc.)","url":"https://apps-in-toss-api.toss.im"}],"security":[{"mutualTLS":[]}],"components":{"securitySchemes":{"mutualTLS":{"description":"This is mTLS authentication based on a client certificate issued to the partner. The mini app is identified by the certificate's CN. For how to issue and manage certificates, [Using the server API](https://developers-apps-in-toss.toss.im/documentation/integration/server-api) please refer to the documentation.","type":"mutualTLS"}},"schemas":{"BulkSendMessageRequest":{"description":"Defines the message to be sent to users in bulk. It includes which message template to use and the list of data to insert into the template.","properties":{"contextList":{"description":"This is the list of the recipient's userKey or anonKey and variable values.","items":{"$ref":"#/components/schemas/BulkSendMessageContext"},"type":"array"},"templateSetCode":{"description":"This is the message template code to use. Enter one of the pre-registered template codes.","type":"string"}},"required":["contextList","templateSetCode"]},"BulkSendMessageContext":{"description":"This is an item that contains information about one recipient and template variable values when sending messages in bulk.","properties":{"anonKey":{"description":"This is the anonymous user identifier issued by the app.","type":"string"},"context":{"additionalProperties":{"type":"object"},"description":"These are the variable values used in the template. For example, values such as the user name or verification code are entered here.","type":"object"},"userKey":{"description":"This is the user's unique identifier.","format":"int64","type":"integer"}},"required":["context"]},"TossApiSuccessBulkSendMessageResponse":{"description":"This is the success response envelope.","properties":{"resultType":{"description":"This is the processing result. On success, `SUCCESS` it is.","enum":["SUCCESS"],"type":"string"},"success":{"$ref":"#/components/schemas/BulkSendMessageResponse"}},"required":["resultType","success"],"type":"object"},"BulkSendMessageResponse":{"description":"It contains how many messages were sent by channel and detailed information about messages that succeeded or failed.","properties":{"detail":{"$ref":"#/components/schemas/AppendContextResultDetailResponse","description":"This is detailed information about messages that were sent successfully."},"fail":{"$ref":"#/components/schemas/AppendContextResultDetailResponse","description":"This is detailed information about messages that failed to send."},"msgCount":{"description":"This is the total number of messages sent.","format":"int32","type":"integer"},"sentAlimtalkCount":{"description":"This is the number of messages sent via Alimtalk.","format":"int32","type":"integer"},"sentFriendtalkCount":{"description":"This is the number of messages sent via Friend Talk.","format":"int32","type":"integer"},"sentInboxCount":{"description":"This is the number of messages sent via Inbox.","format":"int32","type":"integer"},"sentPushCount":{"description":"This is the number of messages sent via Push.","format":"int32","type":"integer"},"sentSmsCount":{"description":"This is the number of messages sent via SMS.","format":"int32","type":"integer"}},"required":["detail","fail","msgCount","sentAlimtalkCount","sentFriendtalkCount","sentInboxCount","sentPushCount","sentSmsCount"]},"AppendContextResultDetailResponse":{"description":"This is a detailed list of messages sent by channel. You can see which messages succeeded or failed in which channel.","properties":{"sentAlimtalk":{"description":"This is a list of messages sent via Alimtalk.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentFriendtalk":{"description":"This is a list of messages sent via Friend Talk.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentInbox":{"description":"This is a list of messages sent via Inbox.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentPush":{"description":"This is a list of messages sent via Push.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentSms":{"description":"This is a list of messages sent via SMS.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"}},"required":["sentAlimtalk","sentFriendtalk","sentInbox","sentPush","sentSms"]},"SentContentResponse":{"description":"This is information about a single sent message.","properties":{"contentId":{"description":"This is the unique ID of the sent message.","type":"string"},"reachedFailReason":{"description":"If message delivery fails, the reason for failure is included.","type":"string"}},"required":["contentId"]},"TossApiFail":{"description":"This is the failure response envelope. Business errors are returned with HTTP 200, so `resultType` be sure to check it.","properties":{"error":{"$ref":"#/components/schemas/TossApiError"},"resultType":{"description":"This is the processing result. `SUCCESS` Treat all values other than `FAIL` as failure. Generally,","enum":["FAIL","HTTP_TIMEOUT","NETWORK_ERROR","EXECUTION_FAIL","INTERRUPTED","INTERNAL_ERROR"],"type":"string"},"success":{"description":"It is always null on failure."}},"required":["error","resultType"],"type":"object"},"TossApiError":{"description":"This is detailed error information.","properties":{"data":{"description":"Additional error information. When the request limit is exceeded `retryAfterSeconds` is included.","type":"object"},"errorCode":{"description":"This is the error code. Refer to each API's business error code table.","type":"string"},"errorType":{"description":"This is an internal error classification value. For error categorization, `errorCode` use it.","format":"int32","type":"integer"},"reason":{"description":"This is a human-readable error description.","type":"string"},"title":{"description":"This is the error title. It is usually null.","type":"string"}},"required":["errorCode","reason"],"type":"object"},"TossApiValidationFail":{"description":"This is the response when request field validation fails.","properties":{"error":{"$ref":"#/components/schemas/TossApiValidationFailError"},"resultType":{"description":"This is the processing result. `SUCCESS` Treat all values other than `FAIL` as failure. Generally,","enum":["FAIL","HTTP_TIMEOUT","NETWORK_ERROR","EXECUTION_FAIL","INTERRUPTED","INTERNAL_ERROR"],"type":"string"},"success":{"description":"It is always null on failure."}},"required":["error","resultType"],"type":"object"},"TossApiValidationFailError":{"description":"This is detailed error information.","properties":{"data":{"description":"Additional error information. When the request limit is exceeded `retryAfterSeconds` is included.","properties":{"errorDetails":{"description":"This is a detailed list of field-level validation failures.","items":{"$ref":"#/components/schemas/TossApiFieldError"},"type":"array"}},"type":"object"},"errorCode":{"description":"This is the error code. Refer to each API's business error code table.","type":"string"},"errorType":{"description":"This is an internal error classification value. For error categorization, `errorCode` use it.","format":"int32","type":"integer"},"reason":{"description":"This is a human-readable error description.","type":"string"},"title":{"description":"This is the error title. It is usually null.","type":"string"}},"required":["errorCode","reason"],"type":"object"},"TossApiFieldError":{"description":"This is a detailed list of field-level validation failures.","properties":{"field":{"description":"This is the name of the field that failed validation.","type":"string"},"message":{"description":"This is the reason for the validation failure.","type":"string"},"rejectedValue":{"description":"This is a rejected input value."}},"type":"object"}}},"paths":{"/api-partner/v1/apps-in-toss/messenger/send-bulk-message":{"post":{"description":"Send messages in bulk to many users with the same template. Use this when sending at least 50 messages in bulk. You can send up to 2,500 messages per request.\n\n### Business error code\n\nThe errors below are returned with HTTP 200 and `resultType: FAIL` are returned.\n\n| errorCode | Description |\n| --------- | ----------------------------------------------------------------------------------------------- |\n| `5004` | This is an unapproved message template. To send messages, template review approval is required. |\n| `4034` | There is no workspace, or you don't have permission to access the workspace |\n| `4095` | Request limit exceeded. Please try again later. |\n\nThis API can pass through the error codes of the connected internal system as-is. Undocumented `errorCode` should be treated as a failure and `reason` Refer to the message.\n\n**Request limit**: 3,000 times per minute per app","operationId":"sendBulkMessage","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSendMessageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"discriminator":{"mapping":{"FAIL":"#/components/schemas/TossApiFail","SUCCESS":"#/components/schemas/TossApiSuccessBulkSendMessageResponse"},"propertyName":"resultType"},"oneOf":[{"$ref":"#/components/schemas/TossApiSuccessBulkSendMessageResponse"},{"$ref":"#/components/schemas/TossApiFail"}]}}},"description":"This is the result of processing the request. `resultType` Use the value to distinguish success/failure."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TossApiValidationFail"}}},"description":"The request body is not in the correct format. `error.data.errorDetails` Check the detailed information for each field below."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TossApiFail"}}},"description":"This is an uncategorized server error. If it keeps failing, contact the partner support channel."}},"summary":"Send bulk messages","tags":["push"]}}}} ``` ## Send test message > This API allows partner apps to receive messages and check whether the pre-review bundle works properly. A user authentication token is required, and it must include the scope permission to send messages to users. All messages, including test sends, can only be sent after passing copy review approval.\ > \ > \### Business error code\ > \ > The errors below are returned with HTTP 200 and \`resultType: FAIL\` are returned.\ > \ > \| errorCode | Description |\ > \| --------- | ----------------------------------------------- |\ > \| \`4010\` | Authentication information couldn't be found. |\ > \| \`4095\` | Request limit exceeded. Please try again later. |\ > \ > This API can pass through the error codes of the connected internal system as-is. Undocumented \`errorCode\` should be treated as a failure and \`reason\` Refer to the message.\ > \ > \*\*Request limit\*\*: 3,000 times per minute per app ```json {"openapi":"3.1.0","info":{"title":"Apps in Toss Partner API","version":"1.0.0"},"tags":[{"description":"This is the API used when partner apps handle messages with Toss users.","name":"push"}],"servers":[{"description":"Operations (for simple login, message sending, Toss Points payout, etc.)","url":"https://apps-in-toss-api.toss.im"}],"security":[{"mutualTLS":[]}],"components":{"securitySchemes":{"mutualTLS":{"description":"This is mTLS authentication based on a client certificate issued to the partner. The mini app is identified by the certificate's CN. For how to issue and manage certificates, [Using the server API](https://developers-apps-in-toss.toss.im/documentation/integration/server-api) please refer to the documentation.","type":"mutualTLS"}},"schemas":{"TestSendMessageRequest":{"description":"Defines the message to send to the user. It includes which message template to use and the data to put into the template.","properties":{"context":{"additionalProperties":{"type":"object"},"description":"These are the variable values used in the template. For example, values such as the user name or verification code are entered here.","type":"object"},"deploymentId":{"description":"This is the identifier of the bundle to use for message-sending tests. It is in UUID format and can be found in the bundle uploaded in the app release menu of the Apps in Toss console.","type":"string"},"templateSetCode":{"description":"This is the message template code to use. Enter one of the pre-registered template codes.","type":"string"}},"required":["context","deploymentId","templateSetCode"],"type":"object"},"TossApiSuccessTestSendMessageResponse":{"description":"This is the success response envelope.","properties":{"resultType":{"description":"This is the processing result. On success, `SUCCESS` it is.","enum":["SUCCESS"],"type":"string"},"success":{"$ref":"#/components/schemas/TestSendMessageResponse"}},"required":["resultType","success"],"type":"object"},"TestSendMessageResponse":{"description":"It contains how many messages were sent by channel and detailed information about messages that succeeded or failed.","properties":{"detail":{"$ref":"#/components/schemas/AppendContextResultDetailResponse","description":"This is detailed information about messages that were sent successfully."},"fail":{"$ref":"#/components/schemas/AppendContextResultDetailResponse","description":"This is detailed information about messages that failed to send."},"msgCount":{"description":"This is the total number of messages sent.","format":"int32","type":"integer"},"sentAlimtalkCount":{"description":"This is the number of messages sent via Alimtalk.","format":"int32","type":"integer"},"sentFriendtalkCount":{"description":"This is the number of messages sent via Friend Talk.","format":"int32","type":"integer"},"sentInboxCount":{"description":"This is the number of messages sent via Inbox.","format":"int32","type":"integer"},"sentPushCount":{"description":"This is the number of messages sent via Push.","format":"int32","type":"integer"},"sentSmsCount":{"description":"This is the number of messages sent via SMS.","format":"int32","type":"integer"}},"required":["detail","fail","msgCount","sentAlimtalkCount","sentFriendtalkCount","sentInboxCount","sentPushCount","sentSmsCount"]},"AppendContextResultDetailResponse":{"description":"This is a detailed list of messages sent by channel. You can see which messages succeeded or failed in which channel.","properties":{"sentAlimtalk":{"description":"This is a list of messages sent via Alimtalk.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentFriendtalk":{"description":"This is a list of messages sent via Friend Talk.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentInbox":{"description":"This is a list of messages sent via Inbox.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentPush":{"description":"This is a list of messages sent via Push.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"},"sentSms":{"description":"This is a list of messages sent via SMS.","items":{"$ref":"#/components/schemas/SentContentResponse"},"type":"array"}},"required":["sentAlimtalk","sentFriendtalk","sentInbox","sentPush","sentSms"]},"SentContentResponse":{"description":"This is information about a single sent message.","properties":{"contentId":{"description":"This is the unique ID of the sent message.","type":"string"},"reachedFailReason":{"description":"If message delivery fails, the reason for failure is included.","type":"string"}},"required":["contentId"]},"TossApiFail":{"description":"This is the failure response envelope. Business errors are returned with HTTP 200, so `resultType` be sure to check it.","properties":{"error":{"$ref":"#/components/schemas/TossApiError"},"resultType":{"description":"This is the processing result. `SUCCESS` Treat all values other than `FAIL` as failure. Generally,","enum":["FAIL","HTTP_TIMEOUT","NETWORK_ERROR","EXECUTION_FAIL","INTERRUPTED","INTERNAL_ERROR"],"type":"string"},"success":{"description":"It is always null on failure."}},"required":["error","resultType"],"type":"object"},"TossApiError":{"description":"This is detailed error information.","properties":{"data":{"description":"Additional error information. When the request limit is exceeded `retryAfterSeconds` is included.","type":"object"},"errorCode":{"description":"This is the error code. Refer to each API's business error code table.","type":"string"},"errorType":{"description":"This is an internal error classification value. For error categorization, `errorCode` use it.","format":"int32","type":"integer"},"reason":{"description":"This is a human-readable error description.","type":"string"},"title":{"description":"This is the error title. It is usually null.","type":"string"}},"required":["errorCode","reason"],"type":"object"},"TossApiValidationFail":{"description":"This is the response when request field validation fails.","properties":{"error":{"$ref":"#/components/schemas/TossApiValidationFailError"},"resultType":{"description":"This is the processing result. `SUCCESS` Treat all values other than `FAIL` as failure. Generally,","enum":["FAIL","HTTP_TIMEOUT","NETWORK_ERROR","EXECUTION_FAIL","INTERRUPTED","INTERNAL_ERROR"],"type":"string"},"success":{"description":"It is always null on failure."}},"required":["error","resultType"],"type":"object"},"TossApiValidationFailError":{"description":"This is detailed error information.","properties":{"data":{"description":"Additional error information. When the request limit is exceeded `retryAfterSeconds` is included.","properties":{"errorDetails":{"description":"This is a detailed list of field-level validation failures.","items":{"$ref":"#/components/schemas/TossApiFieldError"},"type":"array"}},"type":"object"},"errorCode":{"description":"This is the error code. Refer to each API's business error code table.","type":"string"},"errorType":{"description":"This is an internal error classification value. For error categorization, `errorCode` use it.","format":"int32","type":"integer"},"reason":{"description":"This is a human-readable error description.","type":"string"},"title":{"description":"This is the error title. It is usually null.","type":"string"}},"required":["errorCode","reason"],"type":"object"},"TossApiFieldError":{"description":"This is a detailed list of field-level validation failures.","properties":{"field":{"description":"This is the name of the field that failed validation.","type":"string"},"message":{"description":"This is the reason for the validation failure.","type":"string"},"rejectedValue":{"description":"This is a rejected input value."}},"type":"object"}}},"paths":{"/api-partner/v1/apps-in-toss/messenger/send-test-message":{"post":{"description":"This API allows partner apps to receive messages and check whether the pre-review bundle works properly. A user authentication token is required, and it must include the scope permission to send messages to users. All messages, including test sends, can only be sent after passing copy review approval.\n\n### Business error code\n\nThe errors below are returned with HTTP 200 and `resultType: FAIL` are returned.\n\n| errorCode | Description |\n| --------- | ----------------------------------------------- |\n| `4010` | Authentication information couldn't be found. |\n| `4095` | Request limit exceeded. Please try again later. |\n\nThis API can pass through the error codes of the connected internal system as-is. Undocumented `errorCode` should be treated as a failure and `reason` Refer to the message.\n\n**Request limit**: 3,000 times per minute per app","operationId":"sendTestMessage","parameters":[{"description":"It's a key for authenticating users. [Get user information](https://developers-apps-in-toss.toss.im/documentation/api/toss-login#get-api-partner-v1-apps-in-toss-user-oauth2-login-me) You can obtain it through the API","in":"header","name":"x-toss-user-key","required":false,"schema":{"type":"string"}},{"description":"It's a key for authenticating users. In the Mini App SDK, [User.getAnonymousKey](https://developers-apps-in-toss.toss.im/documentation/sdk/domains-api/user/user.getanonymouskey) you can get it with the function","in":"header","name":"x-anon-key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSendMessageRequest"}}},"description":"Information about the message to send","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"discriminator":{"mapping":{"FAIL":"#/components/schemas/TossApiFail","SUCCESS":"#/components/schemas/TossApiSuccessTestSendMessageResponse"},"propertyName":"resultType"},"oneOf":[{"$ref":"#/components/schemas/TossApiSuccessTestSendMessageResponse"},{"$ref":"#/components/schemas/TossApiFail"}]}}},"description":"Message sent successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TossApiValidationFail"}}},"description":"The request body is not in the correct format. `error.data.errorDetails` Check the detailed information for each field below."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TossApiFail"}}},"description":"This is an uncategorized server error. If it keeps failing, contact the partner support channel."}},"summary":"Send test message","tags":["push"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://developers-apps-in-toss.toss.im/api/en/push.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.